CLSCompliantAttribute Класс

Определение

Указывает, соответствует ли элемент программы спецификации CLS.Indicates whether a program element is compliant with the Common Language Specification (CLS). Этот класс не наследуется.This class cannot be inherited.

public ref class CLSCompliantAttribute sealed : Attribute
public sealed class CLSCompliantAttribute : 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
type CLSCompliantAttribute = class
    inherit 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
Наследование
CLSCompliantAttribute
Атрибуты

Примеры

В следующем примере применяется ко CLSCompliantAttribute всей сборке.The following example applies a CLSCompliantAttribute to the entire assembly.

using System;
    [assembly: CLSCompliant(true)]

Следующее объявление создает предупреждение о соответствии CLS, поскольку тип UInt32 не указан в CLS.The following declaration generates a CLS-compliance warning because the type UInt32 is not specified in the CLS.

public int SetValue(UInt32 value);

Если объявление помечено как, то CLSCompliantAttribute предупреждение или ошибка компилятора не создаются.If the declaration is marked with a CLSCompliantAttribute, no compiler warning or error is generated.

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

Комментарии

CLSCompliantAttributeАтрибут используется для указания того, соответствует ли определенный элемент программы спецификации CLS, который определяет функции, которые должен поддерживать любой язык, предназначенный для .NET.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 .NET must support. CLS-совместимость в основном относится к разработчикам библиотек, желающим обеспечить доступ к их библиотекам на любом языке, ориентированном на .NET.CLS compliance is primarily of concern to library developers who want to ensure that their libraries are accessible in any language that targets .NET. Дополнительные сведения см. в разделе независимость от языка и Language-Independent компонентов.For more information, See Language Independence and Language-Independent Components.

Атрибут можно применить CLSCompliantAttribute к следующим элементам программы: сборка, модуль, класс, структура, перечисление, конструктор, метод, свойство, поле, событие, интерфейс, делегат, параметр и возвращаемое значение.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. Однако понятие CLS-совместимости имеет смысл только для сборок, модулей, типов и членов типов, а не частей сигнатуры членов.However, the notion of CLS compliance is only meaningful for assemblies, modules, types, and members of types, not parts of a member signature. Следовательно, CLSCompliantAttribute игнорируется при применении к параметрам программных элементов или возвращаемым значениям.Consequently, CLSCompliantAttribute is ignored when applied to parameter or return value program elements.

Если CLSCompliantAttribute к программному элементу не применено значение No, по умолчанию используется:If no CLSCompliantAttribute is applied to a program element, then by default:

  • Сборка несовместима с CLS.The assembly is not CLS-compliant.

  • Тип является CLS-совместимым, только если его включающий тип или сборка является CLS-совместимым.The type is CLS-compliant only if its enclosing type or assembly is CLS-compliant.

  • Член типа является CLS-совместимым только в том случае, если тип является CLS-совместимым.The member of a type is CLS-compliant only if the type is CLS-compliant.

Если сборка помечена как CLS-совместимая, любой открытый тип в сборке, несовместимой с CLS, должен быть помечен с CLSCompliantAttribute помощью false аргумента.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. Аналогично, если класс помечен как совместимый с CLS, необходимо отдельно пометить все члены, которые не являются CLS-совместимыми.Similarly, if a class is marked as CLS-compliant, you must individually mark all members that are not CLS-compliant. Все члены, не соответствующие требованиям, должны предоставлять соответствующие CLS-совместимые варианты.All non-compliant members must provide corresponding CLS-compliant alternatives.

Атрибуты, которые применяются к сборкам или модулям, должны выполняться using после Imports предложений C# (в Visual Basic) и перед кодом.Attributes that are applied to assemblies or modules must occur after the C# using (Imports in Visual Basic) clauses and before the code.

Дополнительные сведения об использовании атрибутов см. в разделе атрибуты.For more information about using attributes, see Attributes.

Примечание

Текущий компилятор Microsoft Visual Basic намеренно не создает предупреждение о соответствии CLS, однако в будущем выпуске компилятора будет выдано это предупреждение.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.

Конструкторы

CLSCompliantAttribute(Boolean)

Инициализирует экземпляр класса CLSCompliantAttribute логическим значением, указывающим, является ли заданный программный элемент CLS-совместимым.Initializes an instance of the CLSCompliantAttribute class with a Boolean value indicating whether the indicated program element is CLS-compliant.

Свойства

IsCompliant

Возвращает логическое значение, указывающее, является ли заданный программный элемент CLS-совместимым.Gets the Boolean value indicating whether the indicated program element is CLS-compliant.

TypeId

В случае реализации в производном классе возвращает уникальный идентификатор для этого атрибута Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Унаследовано от Attribute)

Методы

Equals(Object)

Возвращает значение, показывающее, равен ли экземпляр указанному объекту.Returns a value that indicates whether this instance is equal to a specified object.

(Унаследовано от Attribute)
GetHashCode()

Возвращает хэш-код данного экземпляра.Returns the hash code for this instance.

(Унаследовано от Attribute)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
IsDefaultAttribute()

При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Унаследовано от Attribute)
Match(Object)

При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Унаследовано от Attribute)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)

Явные реализации интерфейса

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

Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации.Maps a set of names to a corresponding set of dispatch identifiers.

(Унаследовано от Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Возвращает сведения о типе объекта, которые можно использовать для получения сведений о типе интерфейса.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Унаследовано от Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Унаследовано от Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Предоставляет доступ к открытым свойствам и методам объекта.Provides access to properties and methods exposed by an object.

(Унаследовано от Attribute)

Применяется к

См. также раздел