StructLayoutAttribute Třída

Definice

Obor názvů:

System.Runtime.InteropServices

Sestavení:

netstandard.dll, System.Runtime.dll

Zdroj:

StructLayoutAttribute.cs

Umožňuje řídit fyzické rozložení datových polí třídy nebo struktury v paměti.

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

Dědičnost

Object

Attribute

StructLayoutAttribute

Atributy

AttributeUsageAttribute

Příklady

Následující příklad ukazuje spravovanou deklaraci GetSystemTime funkce a definuje MySystemTime třídu s rozložením LayoutKind.Explicit . GetSystemTime získá systémový čas a vytiskne se do konzoly.

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

Poznámky

Tento atribut můžete použít u tříd nebo struktur.

Modul CLR (Common Language Runtime) řídí fyzické rozložení datových polí třídy nebo struktury ve spravované paměti. Pokud však chcete předat typ nespravovanému kódu, můžete pomocí StructLayoutAttribute atributu řídit nespravované rozložení typu. Atribut použijte LayoutKind.Sequential k vynucení, aby členy byly rozloženy postupně v pořadí, v jakém se zobrazují. U blittable typů LayoutKind.Sequential řídí rozložení ve spravované paměti i rozložení v nespravované paměti. U nespravovatelných typů řídí rozložení při zařazování třídy nebo struktury do nespravovaného kódu, ale neřídí rozložení ve spravované paměti. Pomocí atributu LayoutKind.Explicit můžete řídit přesné umístění každého datového členu. To má vliv na spravované i nespravované rozložení u nespravovaných i nespravovaných typů. Použití LayoutKind.Explicit vyžaduje, abyste pomocí FieldOffsetAttribute atributu označili pozici každého pole v rámci typu.

Kompilátory C#, Visual Basic a C++ ve výchozím nastavení aplikují hodnotu rozložení Sequential na struktury. U tříd musíte hodnotu použít LayoutKind.Sequential explicitně. Tlbimp.exe (Type Library Importer) také použije StructLayoutAttribute atribut; při importu knihovny typů vždy použije LayoutKind.Sequential hodnotu.

Konstruktory

Name	Description
StructLayoutAttribute(Int16)	Inicializuje novou instanci StructLayoutAttribute třídy se zadaným LayoutKind členem výčtu.
StructLayoutAttribute(LayoutKind)	Inicializuje novou instanci StructLayoutAttribute třídy se zadaným LayoutKind členem výčtu.

Pole

Name	Description
CharSet	Určuje, zda jsou datová pole řetězců v rámci třídy zařazována jako LPWSTR nebo LPSTR ve výchozím nastavení.
Pack	Řídí zarovnání datových polí třídy nebo struktury v paměti.
Size	Určuje absolutní velikost třídy nebo struktury.

Vlastnosti

Name	Description
TypeId	Při implementaci v odvozené třídě získá jedinečný identifikátor pro tento Attribute. (Zděděno od Attribute)
Value	LayoutKind Získá hodnotu, která určuje, jak je třída nebo struktura uspořádána.

Metody

Name	Description
Equals(Object)	Vrátí hodnotu, která určuje, zda je tato instance rovna zadanému objektu. (Zděděno od Attribute)
GetHashCode()	Vrátí kód hash pro tuto instanci. (Zděděno od Attribute)
GetType()	Získá Type aktuální instance. (Zděděno od Object)
IsDefaultAttribute()	Při přepsání v odvozené třídě určuje, zda hodnota této instance je výchozí hodnotou pro odvozenou třídu. (Zděděno od Attribute)
Match(Object)	Při přepsání v odvozené třídě vrátí hodnotu, která určuje, zda se tato instance rovná zadanému objektu. (Zděděno od Attribute)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Object. (Zděděno od Object)
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)

Viz také

• Tlbimp.exe (importér knihovny typů)