StructLayoutAttribute Classe

Definição

Permite controlar o layout físico dos campos de dados de uma classe ou estrutura na memória.Lets you control the physical layout of the data fields of a class or structure in memory.

public ref class StructLayoutAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Struct, Inherited=false)]
[System.Runtime.InteropServices.ComVisible(true)]
public sealed class StructLayoutAttribute : Attribute
type StructLayoutAttribute = class
    inherit Attribute
Public NotInheritable Class StructLayoutAttribute
Inherits Attribute
Herança
StructLayoutAttribute
Atributos

Exemplos

O exemplo a seguir demonstra uma declaração gerenciada GetSystemTime da função e MySystemTime define a LayoutKind.Explicit classe com layout.The following example demonstrates a managed declaration of the GetSystemTime function and defines MySystemTime class with LayoutKind.Explicit layout. GetSystemTimeObtém a hora do sistema e imprime no console.GetSystemTime gets the system time and prints to the console.

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 NativeMethods
{
public:

   [DllImport("kernel32.dll")]
   static void GetSystemTime( MySystemTime * st );
};

int main()
{
   try
   {
      MySystemTime sysTime;
      NativeMethods::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 );
   }

}

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; 
   }

   internal static class NativeMethods
   {
      [DllImport("kernel32.dll")]
      internal static extern void GetSystemTime([MarshalAs(UnmanagedType.LPStruct)]MySystemTime st);
   };

   class TestApplication
   {      
      public static void Main()
      {
         try
         {
            MySystemTime sysTime = new MySystemTime();
            NativeMethods.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.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


   Friend Class NativeMethods

      <DllImport("kernel32.dll")> _
      Friend Shared Sub GetSystemTime(<MarshalAs(UnmanagedType.LPStruct)> ByVal st As MySystemTime)
      End Sub
   End Class

   Class TestApplication

      Public Shared Sub Main()
         Try
            Dim sysTime As New MySystemTime()
            NativeMethods.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
   End Class
End Namespace 'InteropSample 

Comentários

Você pode aplicar esse atributo a classes ou estruturas.You can apply this attribute to classes or structures.

O Common Language Runtime controla o layout físico dos campos de dados de uma classe ou estrutura na memória gerenciada.The common language runtime controls the physical layout of the data fields of a class or structure in managed memory. No entanto, se você quiser passar o tipo para código não gerenciado, poderá usar o StructLayoutAttribute atributo para controlar o layout não gerenciado do tipo.However, if you want to pass the type to unmanaged code, you can use the StructLayoutAttribute attribute to control the unmanaged layout of the type. Use o atributo com LayoutKind.Sequential para forçar os membros a serem dispostos em sequência na ordem em que aparecem.Use the attribute with LayoutKind.Sequential to force the members to be laid out sequentially in the order they appear. Para tipos blittable, LayoutKind.Sequential o controla o layout na memória gerenciada e o layout na memória não gerenciada.For blittable types, LayoutKind.Sequential controls both the layout in managed memory and the layout in unmanaged memory. Para tipos que não permitem a transferência de bits, ele controla o layout quando a classe ou estrutura é empacotada para código não gerenciado, mas não controla o layout na memória gerenciada.For non-blittable types, it controls the layout when the class or structure is marshaled to unmanaged code, but does not control the layout in managed memory. Use o atributo com LayoutKind.Explicit para controlar a posição exata de cada membro de dados.Use the attribute with LayoutKind.Explicit to control the precise position of each data member. Isso afeta o layout gerenciado e não gerenciado, para tipos de transferência de bits e não-blittable.This affects both managed and unmanaged layout, for both blittable and non-blittable types. Usar LayoutKind.Explicit requer que você use o FieldOffsetAttribute atributo para indicar a posição de cada campo dentro do tipo.Using LayoutKind.Explicit requires that you use the FieldOffsetAttribute attribute to indicate the position of each field within the type.

C#, Visual Basic e C++ compiladores aplicam o Sequential valor de layout a estruturas por padrão.C#, Visual Basic, and C++ compilers apply the Sequential layout value to structures by default. Para classes, você deve aplicar o LayoutKind.Sequential valor explicitamente.For classes, you must apply the LayoutKind.Sequential value explicitly. O Tlbimp. exe (tipo de importador da biblioteca de tipos StructLayoutAttribute ) também aplica o atributo; LayoutKind.Sequential ele sempre aplica o valor quando importa uma biblioteca de tipos.The Tlbimp.exe (Type Library Importer) also applies the StructLayoutAttribute attribute; it always applies the LayoutKind.Sequential value when it imports a type library.

Construtores

StructLayoutAttribute(Int16)

Inicializa uma nova instância da classe StructLayoutAttribute com o membro de enumeração LayoutKind especificado.Initializes a new instance of the StructLayoutAttribute class with the specified LayoutKind enumeration member.

StructLayoutAttribute(LayoutKind)

Inicializa uma nova instância da classe StructLayoutAttribute com o membro de enumeração LayoutKind especificado.Initializes a new instance of the StructLayoutAttribute class with the specified LayoutKind enumeration member.

Campos

CharSet

Indica se o marshaling dos campos de dados da cadeia de caracteres dentro da classe deve ser realizado como LPWSTR ou LPSTR por padrão.Indicates whether string data fields within the class should be marshaled as LPWSTR or LPSTR by default.

Pack

Controla o alinhamento dos campos de dados de uma classe ou estrutura na memória.Controls the alignment of data fields of a class or structure in memory.

Size

Indica o tamanho absoluto da classe ou estrutura.Indicates the absolute size of the class or structure.

Propriedades

TypeId

Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Herdado de Attribute)
Value

Obtém o valor LayoutKind que especifica como a classe ou estrutura é organizada.Gets the LayoutKind value that specifies how the class or structure is arranged.

Métodos

Equals(Object)

Retorna um valor que indica se essa instância é igual a um objeto especificado.Returns a value that indicates whether this instance is equal to a specified object.

(Herdado de Attribute)
GetHashCode()

Retorna o código hash para essa instância.Returns the hash code for this instance.

(Herdado de Attribute)
GetType()

Obtém o Type da instância atual.Gets the Type of the current instance.

(Herdado de Object)
IsDefaultAttribute()

Quando substituído em uma classe derivada, indica se o valor dessa instância é o valor padrão para a classe derivada.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Herdado de Attribute)
Match(Object)

Quando substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um objeto especificado.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Herdado de Attribute)
MemberwiseClone()

Cria uma cópia superficial do Object atual.Creates a shallow copy of the current Object.

(Herdado de Object)
ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.Returns a string that represents the current object.

(Herdado de Object)

Implantações explícitas de interface

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

Mapeia um conjunto de nomes para um conjunto correspondente de identificadores de expedição.Maps a set of names to a corresponding set of dispatch identifiers.

(Herdado de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Recupera as informações de tipo para um objeto, que pode ser usado para obter as informações de tipo para uma interface.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Herdado de Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Retorna o número de interfaces de informações do tipo que um objeto fornece (0 ou 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Herdado de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Fornece acesso a propriedades e métodos expostos por um objeto.Provides access to properties and methods exposed by an object.

(Herdado de Attribute)

Aplica-se a

Veja também