CLSCompliantAttribute (Clase)
Ensamblado: mscorlib (en mscorlib.dll)
[SerializableAttribute] [AttributeUsageAttribute(AttributeTargets.All, Inherited=true, AllowMultiple=false)] [ComVisibleAttribute(true)] public sealed class CLSCompliantAttribute : Attribute
/** @attribute SerializableAttribute() */ /** @attribute AttributeUsageAttribute(AttributeTargets.All, Inherited=true, AllowMultiple=false) */ /** @attribute ComVisibleAttribute(true) */ public final class CLSCompliantAttribute extends Attribute
El atributo CLSCompliantAttribute puede aplicarse a los siguientes elementos de programa: ensamblado, módulo, clase, estructura, enumeración, constructor, método, propiedad, campo, evento, interfaz, delegado, parámetro y valor devuelto. No obstante, la noción de compatibilidad con CLS sólo tiene sentido para los ensamblados, módulos, tipos y miembros de tipos y no para los elementos de una firma de miembro. En consecuencia, se omite CLSCompliantAttribute cuando se aplica a los elementos de programa parámetro o valor devuelto.
Si no se aplica ningún CLSCompliantAttribute a un elemento de programa, de forma predeterminada:
-
El ensamblado no es compatible con CLS.
-
El tipo es compatible con CLS únicamente si el tipo envolvente o el ensamblado son compatibles con CLS.
-
El miembro de un tipo es compatible con CLS sólo si el tipo es compatible con CLS.
Si un ensamblado esta marcado como compatible con CLS, cualquier tipo expuesto públicamente del ensamblado que no sea compatible con CLS deberá marcarse con CLSCompliantAttribute mediante un argumento false. De igual forma, si una clase está marcada como compatible con CLS, deberán marcarse uno por uno todos los miembros que no sean compatibles con CLS. Todos los miembros no compatibles deberán proporcionar alternativas de compatibilidad con CLS.
Los atributos que se aplican a ensamblados o módulos deben tener lugar después de las cláusulas using en C# (Imports en Visual Basic) y antes del código.
Para obtener más información sobre la forma de utilizar atributos, vea Extender metadatos mediante atributos.
Nota |
|---|
| El compilador actual de Microsoft Visual Basic no genera intencionalmente una advertencia de compatibilidad con CLS, sin embargo, una futura versión del compilador emitirá el aviso. |
En el siguiente ejemplo, se aplica CLSCompliantAttribute a todo el ensamblado.
using System;
[assembly:CLSCompliant(true)]
La siguiente declaración genera una advertencia de compatibilidad con CLS porque el tipo UInt32 no se encuentra especificado en CLS.
public int SetValue(UInt32 value);
Si la declaración se marca con un CLSCompliantAttribute, no se genera ninguna advertencia o error del compilador.
[CLSCompliant(false)]
public int SetValue(UInt32 value);
Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium, Windows Mobile para Pocket PC, Windows Mobile para Smartphone, Windows Server 2003, Windows XP Media Center, Windows XP Professional x64, Windows XP SP2, Windows XP Starter Edition
.NET Framework no admite todas las versiones de cada plataforma. Para obtener una lista de las versiones admitidas, vea Requisitos del sistema.
Nota