CLSCompliantAttribute Classe

Definição

Indica se um elemento do programa é compatível com a CLS (Common Language Specification).Indicates whether a program element is compliant with the Common Language Specification (CLS). Essa classe não pode ser herdada.This class cannot be inherited.

public ref class CLSCompliantAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=false, Inherited=true)]
[System.Runtime.InteropServices.ComVisible(true)]
[System.Serializable]
public sealed class CLSCompliantAttribute : Attribute
type CLSCompliantAttribute = class
    inherit Attribute
Public NotInheritable Class CLSCompliantAttribute
Inherits Attribute
Herança
CLSCompliantAttribute
Atributos

Exemplos

O exemplo a seguir aplica CLSCompliantAttribute um ao assembly inteiro.The following example applies a CLSCompliantAttribute to the entire assembly.

using System;  
    [assembly: CLSCompliant(true)]  

A declaração a seguir gera um aviso de conformidade com CLS porque UInt32 o tipo não é especificado no CLS.The following declaration generates a CLS-compliance warning because the type UInt32 is not specified in the CLS.

public int SetValue(UInt32 value);  

Se a declaração for marcada com um CLSCompliantAttribute, nenhum aviso ou erro do compilador será gerado.If the declaration is marked with a CLSCompliantAttribute, no compiler warning or error is generated.

[CLSCompliant(false)]  
 public int SetValue(UInt32 value);  

Comentários

O CLSCompliantAttribute atributo é usado para indicar se um determinado elemento de programa está em conformidade com o Common Language Specification (CLS), que define os recursos que qualquer linguagem que tenha como destino o .NET Framework deve dar suporte.The CLSCompliantAttribute attribute is used to indicate whether a particular program element complies with the Common Language Specification (CLS), which defines the features that any language that targets the .NET Framework must support. A conformidade com CLS é principalmente uma preocupação com os desenvolvedores de biblioteca que desejam garantir que suas bibliotecas estejam acessíveis em qualquer linguagem direcionada ao .NET Framework.CLS compliance is primarily of concern to library developers who want to ensure that their libraries are accessible in any language that targets the .NET Framework. Para obter mais informações, consulte independência de idioma e componentes independentes de linguagem.For more information, See Language Independence and Language-Independent Components.

Você pode aplicar o CLSCompliantAttribute atributo aos seguintes elementos de programa: assembly, módulo, classe, struct, enum, Construtor, método, propriedade, campo, evento, interface, delegado, parâmetro e valor de retorno.You can apply the CLSCompliantAttribute attribute to the following program elements: assembly, module, class, struct, enum, constructor, method, property, field, event, interface, delegate, parameter, and return value. No entanto, a noção de conformidade com CLS só é significativa para assemblies, módulos, tipos e membros de tipos, não partes de uma assinatura de membro.However, the notion of CLS compliance is only meaningful for assemblies, modules, types, and members of types, not parts of a member signature. Consequentemente CLSCompliantAttribute , é ignorado quando aplicado aos elementos do programa de valor de retorno ou parâmetro.Consequently, CLSCompliantAttribute is ignored when applied to parameter or return value program elements.

Se não CLSCompliantAttribute for aplicado a um elemento Program, por padrão:If no CLSCompliantAttribute is applied to a program element, then by default:

  • O assembly não tem conformidade com CLS.The assembly is not CLS-compliant.

  • O tipo será compatível com CLS somente se seu tipo de circunscrição ou assembly for compatível com CLS.The type is CLS-compliant only if its enclosing type or assembly is CLS-compliant.

  • O membro de um tipo é compatível com CLS somente se o tipo for compatível com CLS.The member of a type is CLS-compliant only if the type is CLS-compliant.

Se um assembly estiver marcado como em conformidade com CLS, qualquer tipo exposto publicamente no assembly que não seja compatível com CLS deverá ser marcado com CLSCompliantAttribute o uso false de um argumento.If an assembly is marked as CLS-compliant, any publicly exposed type in the assembly that is not CLS-compliant must be marked with CLSCompliantAttribute using a false argument. Da mesma forma, se uma classe estiver marcada como em conformidade com CLS, você deverá marcar individualmente todos os membros que não são compatíveis com CLS.Similarly, if a class is marked as CLS-compliant, you must individually mark all members that are not CLS-compliant. Todos os membros não compatíveis devem fornecer alternativas compatíveis com CLS correspondentes.All non-compliant members must provide corresponding CLS-compliant alternatives.

Os atributos que são aplicados a assemblies ou módulos devem ocorrer após C# using asImports cláusulas (em Visual Basic) e antes do código.Attributes that are applied to assemblies or modules must occur after the C# using (Imports in Visual Basic) clauses and before the code.

Para obter mais informações sobre como usar atributos, consulte atributos.For more information about using attributes, see Attributes.

Observação

O compilador do Microsoft Visual Basic atual intencionalmente não gera um aviso de conformidade com CLS, no entanto, uma versão futura do compilador emitirá esse aviso.The current Microsoft Visual Basic compiler intentionally does not generate a CLS-compliance warning, however, a future release of the compiler will issue that warning.

Construtores

CLSCompliantAttribute(Boolean)

Inicializa uma instância da classe CLSCompliantAttribute com um valor booliano que indica se o elemento de programa indicado está em conformidade com CLS.Initializes an instance of the CLSCompliantAttribute class with a Boolean value indicating whether the indicated program element is CLS-compliant.

Propriedades

IsCompliant

Obtém o valor booliano que indica se o elemento de programa indicado está em conformidade com CLS.Gets the Boolean value indicating whether the indicated program element is CLS-compliant.

TypeId

Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Herdado de Attribute)

Métodos

Equals(Object)

Retorna um valor que indica se essa instância é igual a um objeto especificado.Returns a value that indicates whether this instance is equal to a specified object.

(Herdado de Attribute)
GetHashCode()

Retorna o código hash para essa instância.Returns the hash code for this instance.

(Herdado de Attribute)
GetType()

Obtém o Type da instância atual.Gets the Type of the current instance.

(Herdado de Object)
IsDefaultAttribute()

Quando substituído em uma classe derivada, indica se o valor dessa instância é o valor padrão para a classe derivada.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Herdado de Attribute)
Match(Object)

Quando substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um objeto especificado.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Herdado de Attribute)
MemberwiseClone()

Cria uma cópia superficial do Object atual.Creates a shallow copy of the current Object.

(Herdado de Object)
ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.Returns a string that represents the current object.

(Herdado de Object)

Implantações explícitas de interface

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Mapeia um conjunto de nomes para um conjunto correspondente de identificadores de expedição.Maps a set of names to a corresponding set of dispatch identifiers.

(Herdado de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Recupera as informações de tipo para um objeto, que pode ser usado para obter as informações de tipo para uma interface.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Herdado de Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Retorna o número de interfaces de informações do tipo que um objeto fornece (0 ou 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Herdado de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Fornece acesso a propriedades e métodos expostos por um objeto.Provides access to properties and methods exposed by an object.

(Herdado de Attribute)

Aplica-se a

Veja também