StructLayoutAttribute Класс

Определение

Пространство имен:

System.Runtime.InteropServices

Сборки:

netstandard.dll, System.Runtime.dll

Исходный код:

StructLayoutAttribute.cs

Позволяет управлять физическим макетом полей данных класса или структуры в памяти.

public ref class StructLayoutAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Struct, Inherited=false)]
public sealed class StructLayoutAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Struct, Inherited=false)>]
type StructLayoutAttribute = class
    inherit Attribute

Public NotInheritable Class StructLayoutAttribute
Inherits Attribute

Наследование

Object

Attribute

StructLayoutAttribute

Атрибуты

AttributeUsageAttribute

Примеры

В следующем примере демонстрируется управляемое объявление GetSystemTime функции и определяет MySystemTime класс с макетом LayoutKind.Explicit . GetSystemTime получает системное время и выводит его в консоль.

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

Комментарии

Этот атрибут можно применить к классам или структурам.

Среда CLR управляет физическим макетом полей данных класса или структуры в управляемой памяти. Однако если вы хотите передать тип в неуправляемый код, можно использовать StructLayoutAttribute атрибут для управления неуправляемой структурой типа. Используйте атрибут, LayoutKind.Sequential чтобы принудительно выложить элементы последовательно в том порядке, в который они отображаются. Для неуправляемых типов управляет как макет в управляемой памяти, LayoutKind.Sequential так и макет в неуправляемой памяти. Для неуправляемых типов он управляет макетом, когда класс или структура маршалируются в неуправляемый код, но не управляет макетом в управляемой памяти. Используйте атрибут для LayoutKind.Explicit управления точной позицией каждого элемента данных. Это влияет как на управляемый, так и неуправляемый макет как для неуправляемых, так и для неуправляемых типов. Для LayoutKind.Explicit указания положения каждого поля в типе требуется использовать FieldOffsetAttribute атрибут.

Компиляторы C#, Visual Basic и C++ применяют значение макета Sequential к структурам по умолчанию. Для классов необходимо явно применить LayoutKind.Sequential значение. Tlbimp.exe (импорт библиотеки типов) также применяет StructLayoutAttribute атрибут. При импорте библиотеки типов всегда применяется LayoutKind.Sequential значение.

Конструкторы

Имя	Описание
StructLayoutAttribute(Int16)	Инициализирует новый экземпляр StructLayoutAttribute класса с указанным LayoutKind элементом перечисления.
StructLayoutAttribute(LayoutKind)	Инициализирует новый экземпляр StructLayoutAttribute класса с указанным LayoutKind элементом перечисления.

Поля

Имя	Описание
CharSet	Указывает, следует ли маршалировать поля строковых данных в классе как LPWSTR или LPSTR по умолчанию.
Pack	Управляет выравниванием полей данных класса или структуры в памяти.
Size	Указывает абсолютный размер класса или структуры.

Свойства

Имя	Описание
TypeId	При реализации в производном классе получает уникальный идентификатор для этого Attribute. (Унаследовано от Attribute)
Value	LayoutKind Возвращает значение, указывающее порядок упорядочения класса или структуры.

Методы

Имя	Описание
Equals(Object)	Возвращает значение, указывающее, равен ли этот экземпляр указанному объекту. (Унаследовано от Attribute)
GetHashCode()	Возвращает хэш-код для этого экземпляра. (Унаследовано от Attribute)
GetType()	Возвращает Type текущего экземпляра. (Унаследовано от Object)
IsDefaultAttribute()	При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса. (Унаследовано от Attribute)
Match(Object)	При переопределении в производном классе возвращает значение, указывающее, равен ли этот экземпляр указанному объекту. (Унаследовано от Attribute)
MemberwiseClone()	Создает неглубокую копию текущей Object. (Унаследовано от Object)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)

См. также раздел

• Tlbimp.exe (импорт библиотеки типов)