Structure (Instrucción)

Artículo
06/08/2023

Declara el nombre de una estructura e introduce la definición de las variables, propiedades, eventos y procedimientos que la estructura incluye.

Sintaxis

[ <attributelist> ] [ accessmodifier ] [ Shadows ] [ Partial ] _
Structure name [ ( Of typelist ) ]
    [ Implements interfacenames ]
    [ datamemberdeclarations ]
    [ methodmemberdeclarations ]
End Structure

Partes

Término	Definición
`attributelist`	Opcional. Consulte Lista de atributos.
`accessmodifier`	Opcional. Puede ser uno de los siguientes: - Public - Protegido - Friend - Privado - Protected Friend - Private Protected Vea Access levels in Visual Basic.
`Shadows`	Opcional. Consulte Shadows.
`Partial`	Opcional. Indica una definición parcial de la estructura. Consulte Partial.
`name`	Necesario. Nombre de esta estructura. Vea Declared Element Names.
`Of`	Opcional. Especifica que se trata de una estructura genérica.
`typelist`	Obligatorio si se utiliza la palabra clave Of. Lista de parámetros de tipo de esta estructura. Consulte Lista de tipos.
`Implements`	Opcional. Indica que esta estructura implementa los miembros de una o más interfaces. Consulte Implements (Instrucción).
`interfacenames`	Es obligatorio si se utiliza la instrucción `Implements`. Nombres de las interfaces implementadas por esta estructura.
`datamemberdeclarations`	Necesario. Cero o más instrucciones `Const`, `Dim`, `Enum` o `Event` que declaran los miembros de datos de la estructura.
`methodmemberdeclarations`	Opcional. Cero o más declaraciones de los procedimientos `Function`, `Operator`, `Property` o `Sub` que sirven como miembros de método de la estructura.
`End Structure`	Necesario. Termina la definición de `Structure`.

Comentarios

La instrucción Structure define un tipo de valor compuesto que se puede personalizar. Una estructura es una generalización de un tipo definido por el usuario de versiones anteriores de Visual Basic. Para obtener más información, consulte Estructuras.

Las estructuras admiten muchas de las mismas características que las clases. Por ejemplo, las estructuras pueden tener propiedades y procedimientos, pueden implementar interfaces y pueden tener constructores con parámetros. No obstante, existen diferencias importantes entre las estructuras y las clases en materias como la herencia, las declaraciones y la utilización. Además, las clases son tipos de referencia y las estructuras son tipos de valor. Para obtener más información, consulte Estructuras y clases.

Structure solo se puede utilizar en un espacio de nombres o un nivel de módulo. Esto significa que el contexto de la declaración de una estructura debe ser un archivo de código fuente, un espacio de nombres, una clase, una estructura, un módulo o una interfaz y no puede ser un procedimiento ni un bloque. Para obtener más información, vea Declaration Contexts and Default Access Levels (Contextos de declaración y niveles de acceso predeterminados).

De manera predeterminada, el acceso a las estructuras es de tipo Friend. Los niveles de acceso se pueden ajustar con los modificadores de acceso. Para obtener más información, consulte Niveles de acceso en Visual Basic.

Reglas

Anidamiento. Puede definirse una estructura dentro de otra. La estructura exterior se denomina estructura contenedora, y la interna, estructura anidada. Sin embargo, no se puede tener acceso a los miembros de una estructura anidada a través de la estructura contenedora. En lugar de ello, se debe declarar una variable del tipo de datos de la estructura anidada.
Declaración de miembros. Se debe declarar cada miembro de una estructura. Los miembros de una estructura no pueden ser de tipo Protected ni Protected Friend ya que no se puede heredar nada de una estructura. La propia estructura, sin embargo, puede ser de tipo Protected o Protected Friend.

En una estructura se pueden declarar cero o más variables no compartidas o eventos no compartidos y no personalizados. No pueden utilizarse únicamente constantes, propiedades y procedimientos, aunque algunos sean no compartidos.
Inicialización. No se puede inicializar el valor de ningún miembro de datos de una estructura no compartido como parte de su declaración. Dicho miembro de datos se debe inicializar mediante un constructor con parámetros en la estructura o bien mediante la asignación de un valor al miembro después de crear una instancia de la estructura.
Herencia. Una estructura no puede heredar de ningún tipo distinto de ValueType, del que todas las estructuras heredan. En particular, una estructura no puede heredar de otra.

La instrucción Inherits no se puede utilizar en una definición de estructura, ni siquiera para especificar ValueType.
Implementación. Si la estructura utiliza la instrucción Implements, se debe implementar cada miembro definido por cada interfaz que se especifica en interfacenames.
Propiedad Default. Una estructura puede especificar a lo sumo una propiedad como su propiedad predeterminada, mediante el modificador Default. Para obtener más información, consulte Default.

Comportamiento

Nivel de acceso. En una estructura, cada miembro se puede declarar con su propio nivel de acceso. El acceso predeterminado de todos los miembros de la estructura es de tipo Public. Tenga en cuenta que si la propia estructura utiliza un nivel de acceso más limitado, se restringe automáticamente el acceso a sus miembros, aunque los niveles de acceso se ajusten con modificadores.
Ámbito. Una estructura está en ámbito en su espacio de nombres, clase, estructura o módulo contenedores.

El ámbito de todos los miembros de la estructura es la estructura completa.
Lifetime (Duración). Una estructura no dispone por sí misma de período de duración. Más bien, cada instancia de esa estructura tiene un período de duración independiente de todas las demás instancias.

El período de duración de una instancia comienza cuando se crea con una cláusula New Operator. Finaliza cuando finaliza el período de duración de la variable que la contiene.

No puede extender el período de duración de una instancia de estructura. Los módulos proporcionan una aproximación a la funcionalidad de estructura estática. Para más información, consulte la instrucción Module.

Los miembros de estructura disponen de un período de duración en función de cómo y donde se declaran. Para obtener más información, consulte el apartado sobre períodos de duración en Class (Instrucción).
Calificación. El código que se incluye fuera de una estructura debe calificar el nombre de un miembro con el nombre de dicha estructura.

Si el código incluido en una estructura anidada realiza una referencia sin calificar a un elemento de programación, Visual Basic busca este elemento en la estructura anidada en primer lugar, a continuación en la estructura contenedora y así sucesivamente hasta el elemento contenedor principal. Para obtener más información, consulta References to Declared Elements.
Consumo de memoria. Al igual que sucede con los demás tipos de datos compuestos, no puede calcularse de forma precisa el consumo total de memoria de una estructura sumando las asignaciones de almacenamiento nominal de sus miembros. Es más, no puede suponerse que el orden de almacenamiento en memoria sea el mismo que el orden de la declaración. Si necesita controlar el diseño de almacenamiento de una estructura, puede aplicar el atributo StructLayoutAttribute a la instrucción Structure.

Ejemplo

En el siguiente ejemplo se utiliza la instrucción Structure para definir un conjunto de datos relacionados de un empleado. Se muestra el uso de los miembros Public, Friend y Private para reflejar la confidencialidad de los elementos de datos. También se muestran los miembros de evento, propiedad y procedimiento.

Public Structure employee
    ' Public members, accessible from throughout declaration region.
    Public firstName As String
    Public middleName As String
    Public lastName As String
    ' Friend members, accessible from anywhere within the same assembly.
    Friend employeeNumber As Integer
    Friend workPhone As Long
    ' Private members, accessible only from within the structure itself.
    Private homePhone As Long
    Private level As Integer
    Private salary As Double
    Private bonus As Double
    ' Procedure member, which can access structure's private members.
    Friend Sub CalculateBonus(ByVal rate As Single)
        bonus = salary * CDbl(rate)
    End Sub
    ' Property member to return employee's eligibility.
    Friend ReadOnly Property Eligible() As Boolean
        Get
            Return level >= 25
        End Get
    End Property
    ' Event member, raised when business phone number has changed.
    Public Event ChangedWorkPhone(ByVal newPhone As Long)
End Structure

Para obtener más información sobre cómo usar variables Structure, consulte Structure (Variable).

Compartir vía