Clase StructLayoutAttribute
Publicado: octubre de 2016
Le permite controlar el diseño físico de los campos de datos de una clase o una estructura en la memoria.
Espacio de nombres: System.Runtime.InteropServices
Ensamblado: mscorlib (en mscorlib.dll)
Jerarquía de herencia
System.Object
System.Attribute
System.Runtime.InteropServices.StructLayoutAttribute
Sintaxis
[AttributeUsageAttribute(AttributeTargets.Class | AttributeTargets.Struct,
Inherited = false)]
[ComVisibleAttribute(true)]
public sealed class StructLayoutAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::Class | AttributeTargets::Struct,
Inherited = false)]
[ComVisibleAttribute(true)]
public ref class StructLayoutAttribute sealed : Attribute
[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class | AttributeTargets.Struct,
Inherited = false)>]
[<ComVisibleAttribute(true)>]
type StructLayoutAttribute =
class
inherit Attribute
end
<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Struct,
Inherited := False)>
<ComVisibleAttribute(True)>
Public NotInheritable Class StructLayoutAttribute
Inherits Attribute
Constructores
| Nombre | Descripción | |
|---|---|---|
.jpeg "System_CAPS_pubmethod") |
StructLayoutAttribute(Int16) | Inicializa una nueva instancia de la clase StructLayoutAttribute con el miembro de enumeración System.Runtime.InteropServices.LayoutKind especificado. |
|
StructLayoutAttribute(LayoutKind) | Inicializa una nueva instancia de la clase StructLayoutAttribute con el miembro de enumeración System.Runtime.InteropServices.LayoutKind especificado. |
Propiedades
| Nombre | Descripción | |
|---|---|---|
.jpeg "System_CAPS_pubproperty") |
TypeId | Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute.(Heredado de Attribute). |
|
Value | Obtiene el valor de LayoutKind que especifica la forma en que está organizada la clase o estructura. |
Métodos
| Nombre | Descripción | |
|---|---|---|
|
Equals(Object) | Esta API admite la infraestructura producto y no está diseñada para usarse directamente desde el código. Devuelve un valor que indica si esta instancia es igual que un objeto especificado.(Heredado de Attribute). |
|
GetHashCode() | Devuelve el código hash de esta instancia.(Heredado de Attribute). |
|
GetType() | Obtiene el Type de la instancia actual.(Heredado de Object). |
|
IsDefaultAttribute() | Si se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada.(Heredado de Attribute). |
|
Match(Object) | Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado.(Heredado de Attribute). |
|
ToString() | Devuelve una cadena que representa el objeto actual.(Heredado de Object). |
Campos
| Nombre | Descripción | |
|---|---|---|
.jpeg "System_CAPS_pubfield") |
CharSet | Indica si las referencias de los campos de datos de cadena dentro de la clase deben calcularse como LPWSTR o LPSTR de forma predeterminada. |
|
Pack | Controla la alineación de los campos de datos de una clase o una estructura en la memoria. |
|
Size | Indica el tamaño absoluto de la clase o estructura. |
Implementaciones de interfaz explícitas
| Nombre | Descripción | |
|---|---|---|
.jpeg "System_CAPS_pubinterface") .jpeg "System_CAPS_privmethod") |
_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) | Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío.(Heredado de Attribute). |
|
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) | Obtiene la información de tipos de un objeto, que puede utilizarse para obtener la información de tipos de una interfaz.(Heredado de Attribute). |
|
_Attribute.GetTypeInfoCount(UInt32) | Recupera el número de interfaces de información de tipo que proporciona un objeto (0 ó 1).(Heredado de Attribute). |
|
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) | Proporciona acceso a las propiedades y los métodos expuestos por un objeto.(Heredado de Attribute). |
Comentarios
Este atributo se puede aplicar a clases o estructuras.
Common language runtime controla la distribución física de los campos de datos de una clase o estructura en la memoria administrada. Sin embargo, si desea pasar el tipo a código no administrado, puede utilizar el StructLayoutAttribute atributo para controlar el diseño del tipo no administrado. Utilice el atributo con LayoutKind.Sequential para forzar que los miembros que se distribuyan secuencialmente en el orden en que aparecen.LayoutKind.Sequential Controla tanto el diseño en la memoria administrada y el diseño de memoria no administrada. Para los tipos, controla el diseño cuando la clase o estructura se calculan las referencias a código no administrado, pero no controla el diseño en la memoria administrada. Utilice el atributo con LayoutKind.Explicit para controlar la posición exacta de cada miembro de datos. Esto afecta al diseño administrado y no administrado, para los tipos bits/bytes y no bits/bytes. Mediante LayoutKind.Explicit requiere el uso de la FieldOffsetAttribute atributo para indicar la posición de cada campo dentro del tipo.
Los compiladores de C#, Visual Basic y C++ aplican el Sequential valor de diseño a las estructuras de forma predeterminada. Para las clases, debe aplicar el LayoutKind.Sequential valor explícitamente. El Tlbimp.exe (Type Library Importer) también se aplica el StructLayoutAttribute atributo; siempre se aplica el LayoutKind.Sequential cuando importa una biblioteca de tipos de valor.
Ejemplos
En el ejemplo siguiente se muestra una declaración administrada de la GetSystemTime de función y define MySystemTime con la clase LayoutKind.Explicit Diseño.GetSystemTime Obtiene la hora del sistema y la imprime en la consola.
using System;
using System.Runtime.InteropServices;
namespace InteropSample
{
[StructLayout(LayoutKind.Explicit, Size=16, CharSet=CharSet.Ansi)]
public class MySystemTime
{
[FieldOffset(0)]public ushort wYear;
[FieldOffset(2)]public ushort wMonth;
[FieldOffset(4)]public ushort wDayOfWeek;
[FieldOffset(6)]public ushort wDay;
[FieldOffset(8)]public ushort wHour;
[FieldOffset(10)]public ushort wMinute;
[FieldOffset(12)]public ushort wSecond;
[FieldOffset(14)]public ushort wMilliseconds;
}
class LibWrapper
{
[DllImport("kernel32.dll")]
public static extern void GetSystemTime([MarshalAs(UnmanagedType.LPStruct)]MySystemTime st);
};
class TestApplication
{
public static void Main()
{
try
{
MySystemTime sysTime = new MySystemTime();
LibWrapper.GetSystemTime(sysTime);
Console.WriteLine("The System time is {0}/{1}/{2} {3}:{4}:{5}", sysTime.wDay,
sysTime.wMonth, sysTime.wYear, sysTime.wHour, sysTime.wMinute, sysTime.wSecond);
}
catch(TypeLoadException e)
{
Console.WriteLine("TypeLoadException : " + e.Message);
}
catch(Exception e)
{
Console.WriteLine("Exception : " + e.Message);
}
}
}
}
Imports System
Imports System.Runtime.InteropServices
Namespace InteropSample
<StructLayout(LayoutKind.Explicit, Size:=16, CharSet:=CharSet.Ansi)> _
Public Class MySystemTime
<FieldOffset(0)> Public wYear As Short
<FieldOffset(2)> Public wMonth As Short
<FieldOffset(4)> Public wDayOfWeek As Short
<FieldOffset(6)> Public wDay As Short
<FieldOffset(8)> Public wHour As Short
<FieldOffset(10)> Public wMinute As Short
<FieldOffset(12)> Public wSecond As Short
<FieldOffset(14)> Public wMilliseconds As Short
End Class 'MySystemTime
Class LibWrapper
<DllImport("kernel32.dll")> _
Public Shared Sub GetSystemTime(<MarshalAs(UnmanagedType.LPStruct)> ByVal st As MySystemTime)
End Sub
End Class 'LibWrapper
Class TestApplication
Public Shared Sub Main()
Try
Dim sysTime As New MySystemTime()
LibWrapper.GetSystemTime(sysTime)
Console.WriteLine("The System time is {0}/{1}/{2} {3}:{4}:{5}", sysTime.wDay, sysTime.wMonth, sysTime.wYear, sysTime.wHour, sysTime.wMinute, sysTime.wSecond)
Catch e As TypeLoadException
Console.WriteLine(("TypeLoadException : " + e.Message.ToString()))
Catch e As Exception
Console.WriteLine(("Exception : " + e.Message.ToString()))
End Try
End Sub 'Main
End Class 'TestApplication
End Namespace 'InteropSample
using namespace System;
using namespace System::Runtime::InteropServices;
[StructLayout(LayoutKind::Explicit,Size=16,CharSet=CharSet::Ansi)]
value class MySystemTime
{
public:
[FieldOffset(0)]
short wYear;
[FieldOffset(2)]
short wMonth;
[FieldOffset(4)]
short wDayOfWeek;
[FieldOffset(6)]
short wDay;
[FieldOffset(8)]
short wHour;
[FieldOffset(10)]
short wMinute;
[FieldOffset(12)]
short wSecond;
[FieldOffset(14)]
short wMilliseconds;
};
ref class LibWrapper
{
public:
[DllImport("kernel32.dll")]
static void GetSystemTime( MySystemTime * st );
};
int main()
{
try
{
MySystemTime sysTime;
LibWrapper::GetSystemTime( &sysTime );
Console::WriteLine( "The System time is {0}/{1}/{2} {3}:{4}:{5}", sysTime.wDay, sysTime.wMonth, sysTime.wYear, sysTime.wHour, sysTime.wMinute, sysTime.wSecond );
}
catch ( TypeLoadException^ e )
{
Console::WriteLine( "TypeLoadException : {0}", e->Message );
}
catch ( Exception^ e )
{
Console::WriteLine( "Exception : {0}", e->Message );
}
}
Información de versión
Plataforma universal de Windows
Disponible desde 8
.NET Framework
Disponible desde 1.1
Biblioteca de clases portable
Se admite en: plataformas portátiles de .NET
Silverlight
Disponible desde 2.0
Windows Phone Silverlight
Disponible desde 7.0
Windows Phone
Disponible desde 8.1
Seguridad para subprocesos
Cualquier miembro ( Compartido en Visual Basic) estático público de este tipo es seguro para subprocesos. No se garantiza que los miembros de instancia sean seguros para subprocesos.
Ver también
Espacio de nombres System.Runtime.InteropServices
Tlbimp.exe (Type Library Importer)
Volver al principio