CA1402: Evitar sobrecargas em interfaces de COM visíveis

Artigo
08/08/2011

TypeName	AvoidOverloadsInComVisibleInterfaces
CheckId	CA1402
<strong>Categoria</strong>	Microsoft.Interoperability
Alteração significativa	Quebrando

Causa

Um modelo de objeto de componente (COM) declara a interface visível sobrecarregado métodos.

Descrição da regra

Quando os métodos sobrecarregados estão expostos a clientes COM, somente a primeira sobrecarga de método manterá seu nome. Sobrecargas subseqüentes são exclusivamente renomeadas anexando o nome de um caractere de sublinhado '_' e um número inteiro que corresponde à ordem de declaração de sobrecarga. Por exemplo, considere os seguintes métodos.

   void SomeMethod(int valueOne);
   void SomeMethod(int valueOne, int valueTwo, int valueThree);
   void SomeMethod(int valueOne, int valueTwo);

Esses métodos são expostos para os clientes COM a seguinte.

   void SomeMethod(int valueOne);
   void SomeMethod_2(int valueOne, int valueTwo, int valueThree);
   void SomeMethod_3(int valueOne, int valueTwo);

Clientes COM 6 de Visual Basic não podem implementar métodos de interface usando um sublinhado no nome.

Como corrigir violações

Para corrigir uma violação desta regra, renomeie os métodos sobrecarregados para que os nomes são exclusivos. Como alternativa, fazer a interface invisível COM alterando a acessibilidade para internal (Friend na Visual Basic) ou aplicando o System.Runtime.InteropServices.ComVisibleAttribute atributo definido como false.

Quando suprimir avisos

Não suprimir um aviso da regra.

Exemplo

O exemplo a seguir mostra uma interface que viola a regra e uma interface que satisfaça a regra.

Imports System
Imports System.Runtime.InteropServices

<Assembly: ComVisibleAttribute(False)>
Namespace InteroperabilityLibrary

   ' This interface violates the rule.
   <ComVisibleAttribute(True)> _ 
   Public Interface IOverloadedInterface

      Sub SomeSub(valueOne As Integer)
      Sub SomeSub(valueOne As Integer, valueTwo As Integer)

   End Interface

   ' This interface satisfies the rule.
   <ComVisibleAttribute(True)> _ 
   Public Interface INotOverloadedInterface

      Sub SomeSub(valueOne As Integer)
      Sub AnotherSub(valueOne As Integer, valueTwo As Integer)

   End Interface

End Namespace

using System;
using System.Runtime.InteropServices;

[assembly: ComVisible(false)]
namespace InteroperabilityLibrary
{
   // This interface violates the rule.
   [ComVisible(true)]
   public interface IOverloadedInterface
   {
      void SomeMethod(int valueOne);
      void SomeMethod(int valueOne, int valueTwo);
   }

   // This interface satisfies the rule.
   [ComVisible(true)]
   public interface INotOverloadedInterface
   {
      void SomeMethod(int valueOne);
      void AnotherMethod(int valueOne, int valueTwo);
   }
}