StructLayoutAttribute Klasse

Definition

Namespace:

System.Runtime.InteropServices

Assembly:

System.Runtime.dll

Quelle:

StructLayoutAttribute.cs

Hiermit können Sie das physikalische Layout der Datenfelder einer Klasse oder Struktur im Speicher steuern.

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

Vererbung

Object

Attribute

StructLayoutAttribute

Attribute

AttributeUsageAttribute

Beispiele

Im folgenden Beispiel wird eine verwaltete Deklaration der GetSystemTime Funktion veranschaulicht und eine MySystemTime Klasse mit LayoutKind.Explicit Layout definiert. GetSystemTime ruft die Systemzeit ab und gibt in der Konsole aus.

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

Hinweise

Sie können dieses Attribut auf Klassen oder Strukturen anwenden.

Die Common Language Runtime steuert das physische Layout der Datenfelder einer Klasse oder Struktur im verwalteten Arbeitsspeicher. Wenn Sie den Typ jedoch an nicht verwalteten Code übergeben möchten, können Sie das StructLayoutAttribute -Attribut verwenden, um das nicht verwaltete Layout des Typs zu steuern. Verwenden Sie das -Attribut mit LayoutKind.Sequential , um zu erzwingen, dass die Elemente sequenziell in der angezeigten Reihenfolge angeordnet werden. Für blittbare Typen LayoutKind.Sequential steuert sowohl das Layout im verwalteten Arbeitsspeicher als auch das Layout im nicht verwalteten Arbeitsspeicher. Bei nicht blittbaren Typen steuert sie das Layout, wenn die Klasse oder Struktur in nicht verwalteten Code gemarst wird, aber nicht das Layout im verwalteten Arbeitsspeicher. Verwenden Sie das -Attribut mit LayoutKind.Explicit , um die genaue Position der einzelnen Datenmember zu steuern. Dies wirkt sich sowohl auf das verwaltete als auch auf das nicht verwaltete Layout aus, sowohl für blittbare als auch für nicht blittbare Typen. Die Verwendung LayoutKind.Explicit erfordert, dass Sie das FieldOffsetAttribute -Attribut verwenden, um die Position jedes Felds innerhalb des Typs anzugeben.

C#-, Visual Basic- und C++-Compiler wenden den Sequential Layoutwert standardmäßig auf Strukturen an. Für Klassen müssen Sie den LayoutKind.Sequential Wert explizit anwenden. Tlbimp.exe (Type Library Importer) wendet auch das StructLayoutAttribute Attribut an. Beim Importieren einer Typbibliothek wird immer der LayoutKind.Sequential Wert angewendet.

Konstruktoren

StructLayoutAttribute(Int16)	Initialisiert eine neue Instanz der StructLayoutAttribute-Klasse mit dem angegebenen LayoutKind-Enumerationsmember.
StructLayoutAttribute(LayoutKind)	Initialisiert eine neue Instanz der StructLayoutAttribute-Klasse mit dem angegebenen LayoutKind-Enumerationsmember.

Felder

CharSet	Gibt an, ob Zeichenfolgendatenfelder in der Klasse standardmäßig als LPWSTR oder als LPSTR gemarshallt werden müssen.
Pack	Steuert die Ausrichtung der Datenfelder einer Klasse oder Struktur im Speicher.
Size	Gibt die absolute Größe der Klasse oder Struktur an.

Eigenschaften

TypeId	Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab. (Geerbt von Attribute)
Value	Ruft den LayoutKind-Wert ab, der angibt, wie die Klasse oder Struktur angeordnet ist.

Methoden

Equals(Object)	Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist. (Geerbt von Attribute)
GetHashCode()	Gibt den Hashcode für diese Instanz zurück. (Geerbt von Attribute)
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
IsDefaultAttribute()	Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist. (Geerbt von Attribute)
Match(Object)	Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht. (Geerbt von Attribute)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)

Weitere Informationen

• Tlbimp.exe (Type Library Importer-Tool)