Lista de atributos (Visual Basic)

Artículo
08/10/2011

Especifica los atributos que se van a aplicar a un elemento de programación declarado. Los atributos múltiples se separan por comas. A continuación, aparece la sintaxis para un atributo.

[ attributemodifier ] attributename [ ( attributearguments | attributeinitializer ) ]

Partes

attributemodifier
Obligatorio para atributos aplicados al principio de un archivo de código fuente. Puede ser Assembly (Visual Basic) o Module.
attributename
Obligatorio. Nombre del atributo.
attributearguments
Opcional. Lista de argumentos por posición de este atributo. Los argumentos múltiples se separan por comas.
attributeinitializer
Opcional. Lista de inicializadores de variables o propiedades de este atributo. Los inicializadores múltiples se separan por comas.

Comentarios

Puede aplicar uno o más atributos a casi cualquier elemento de programación (tipos, procedimientos, propiedades, etc.). Los atributos aparecen en los metadatos del ensamblado y sirven de ayuda para anotar el código o especificar cómo se utiliza un elemento de programación determinado. Puede aplicar atributos definidos por Visual Basic y .NET Framework, así como definir sus propios atributos.

Para obtener más información sobre cuándo se utilizan atributos, vea Atributos (C# y Visual Basic). Para obtener más información sobre nombres de atributo, vea Nombres de elementos declarados (Visual Basic).

Reglas

Colocación. Puede aplicar atributos a la mayoría de elementos de programación declarados. Para aplicar uno o más atributos, coloque un bloque de atributos al principio de la declaración del elemento. Cada entrada de la lista de atributos especifica un atributo que desea aplicar, y el modificador y argumentos que está utilizando para esta invocación del atributo.
Corchetes angulares. Si proporciona una lista de atributos, debe incluirla entre corchetes angulares ("<" y ">").
Parte de la declaración. El atributo debe formar la parte de la declaración del elemento y no una instrucción independiente. Puede utilizar la secuencia de continuación de línea (" _") para extender la instrucción de declaración a varias líneas del código fuente.
Modificadores. Es obligatorio utilizar un modificador de atributo (Assembly o Module) en cada atributo aplicado a un elemento de programación al principio de un archivo de código fuente. No se permiten modificadores de atributo en atributos aplicados a elementos que no estén al principio de un archivo de código fuente.
Argumentos. Todos los argumentos posicionales para un atributo deben preceder a cualquier inicializador de variable o de propiedad.

Ejemplo

En el ejemplo siguiente se aplica el atributo DllImportAttribute al esquema de una definición de un procedimiento Function.

<DllImportAttribute("kernel32.dll", EntryPoint:="MoveFileW",
    SetLastError:=True, CharSet:=CharSet.Unicode,
    ExactSpelling:=True,
    CallingConvention:=CallingConvention.StdCall)>
Public Shared Function moveFile(ByVal src As String,
  ByVal dst As String) As Boolean
    ' This function copies a file from the path src to the path dst.
    ' Leave this function empty. The DLLImport attribute forces calls
    ' to moveFile to be forwarded to MoveFileW in KERNEL32.DLL.
End Function

DllImportAttribute indica que el procedimiento con atributos representa un punto de entrada en una biblioteca de vínculos dinámicos no administrada (archivo DLL). El atributo proporciona el nombre del archivo DLL como argumento posicional y el resto de la información como inicializadores de variables.