CLSCompliantAttribute Classe

Referência

Definição

Namespace:: System

Assembly:: System.Runtime.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Indica se um elemento do programa é compatível com a CLS (Common Language Specification). Essa classe não pode ser herdada.

public ref class CLSCompliantAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=false, Inherited=true)]
public sealed class CLSCompliantAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=false, Inherited=true)]
[System.Serializable]
public sealed class CLSCompliantAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=false, Inherited=true)]
[System.Serializable]
[System.Runtime.InteropServices.ComVisible(true)]
public sealed class CLSCompliantAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=false, Inherited=true)>]
type CLSCompliantAttribute = class
    inherit Attribute

[<System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=false, Inherited=true)>]
[<System.Serializable>]
type CLSCompliantAttribute = class
    inherit Attribute

[<System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=false, Inherited=true)>]
[<System.Serializable>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type CLSCompliantAttribute = class
    inherit Attribute

Public NotInheritable Class CLSCompliantAttribute
Inherits Attribute

Herança: Object

Attribute
CLSCompliantAttribute

Atributos: AttributeUsageAttribute SerializableAttribute ComVisibleAttribute

Exemplos

O exemplo a seguir aplica-se a todo CLSCompliantAttribute o assembly.

using System;
    [assembly: CLSCompliant(true)]

A declaração a seguir gera um aviso de conformidade com CLS porque o tipo UInt32 não é especificado no CLS.

public int SetValue(UInt32 value);

Se a declaração for marcada com um CLSCompliantAttribute, nenhum aviso ou erro do compilador será gerado.

[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 a CLS (Common Language Specification), que define os recursos que qualquer idioma direcionado ao .NET deve oferecer suporte. A conformidade com CLS é principalmente preocupante para desenvolvedores de biblioteca que desejam garantir que suas bibliotecas estejam acessíveis em qualquer idioma direcionado ao .NET. Para obter mais informações, consulte independência da linguagem e componentes de Language-Independent.

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. 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. Consequentemente, CLSCompliantAttribute é ignorado quando aplicado a elementos de programa de parâmetro ou valor retornado.

Se não CLSCompliantAttribute for aplicado a um elemento de programa, por padrão:

O assembly não é compatível com CLS.
O tipo só será compatível com CLS se o tipo ou o assembly de associação for compatível com CLS.
O membro de um tipo só será compatível com CLS se o tipo for compatível com CLS.

Se um assembly for marcado como compatível com CLS, qualquer tipo exposto publicamente no assembly que não esteja em conformidade com CLS deverá ser marcado com CLSCompliantAttribute o uso de um false argumento. Da mesma forma, se uma classe for marcada como compatível com CLS, você deverá marcar individualmente todos os membros que não estão em conformidade com CLS. Todos os membros não compatíveis devem fornecer alternativas compatíveis com CLS correspondentes.

Os atributos aplicados a assemblies ou módulos devem ocorrer após as cláusulas C# using (Importsem Visual Basic) e antes do código.

Para obter mais informações sobre como usar atributos, consulte Atributos.

Observação

O compilador atual do Microsoft Visual Basic intencionalmente não gera um aviso de conformidade com CLS, no entanto, uma versão futura do compilador emitirá esse aviso.

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.

Propriedades

IsCompliant	Obtém o valor booliano que indica se o elemento de programa indicado está em conformidade com CLS.
TypeId	Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute. (Herdado de Attribute)

Métodos

Equals(Object)	Retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
GetHashCode()	Retorna o código hash para a instância. (Herdado de Attribute)
GetType()	Obtém o Type da instância atual. (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. (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. (Herdado de Attribute)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (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. (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. (Herdado de Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Retorna o número de interfaces de informações do tipo que um objeto fornece (0 ou 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. (Herdado de Attribute)

Aplica-se a

Compartilhar via