StructLayoutAttribute Osztály

Definíció

Névtér:

System.Runtime.InteropServices

Szerelvény:

mscorlib.dll

Lehetővé teszi egy osztály vagy struktúra adatmezőinek fizikai elrendezésének szabályozását a memóriában.

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

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

Public NotInheritable Class StructLayoutAttribute
Inherits Attribute

Öröklődés

Object

Attribute

StructLayoutAttribute

Attribútumok

AttributeUsageAttribute ComVisibleAttribute

Példák

Az alábbi példa a függvény felügyelt deklarációját GetSystemTime mutatja be, és elrendezéssel rendelkező LayoutKind.Explicit osztályt MySystemTime határoz meg. GetSystemTime lekéri a rendszeridőt, és kinyomtatja a konzolon.

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

Megjegyzések

Ezt az attribútumot osztályokra vagy struktúrákra is alkalmazhatja.

A közös nyelvi futtatókörnyezet szabályozza egy osztály vagy struktúra adatmezőinek fizikai elrendezését a felügyelt memóriában. Ha azonban nem felügyelt kódnak szeretné átadni a típust, az StructLayoutAttribute attribútummal szabályozhatja a típus nem felügyelt elrendezését. Az attribútum használatával LayoutKind.Sequential kényszerítheti a tagokat, hogy egymás után, a megjelenő sorrendben legyenek elhelyezve. A titkos típusok LayoutKind.Sequential esetében a felügyelt memória elrendezését és a nem felügyelt memória elrendezését is szabályozza. Nem titkos típusok esetén az elrendezést szabályozza, ha az osztály vagy a struktúra nem felügyelt kódra van állítva, de nem szabályozza az elrendezést a felügyelt memóriában. Az attribútum használatával LayoutKind.Explicit szabályozhatja az egyes adattagok pontos pozícióját. Ez mind a felügyelt, mind a nem felügyelt elrendezésre hatással van mind a titkos, mind a nem titkos típusok esetében. A használathoz LayoutKind.Explicit az FieldOffsetAttribute attribútumot kell használnia az egyes mezők típuson belüli pozíciójának jelzéséhez.

A C#, Visual Basic és C++ fordítók alapértelmezés szerint a Sequential elrendezési értéket alkalmazzák a struktúrákra. Az osztályok esetében az LayoutKind.Sequential értéket explicit módon kell alkalmaznia. Tlbimp.exe (Típustár-importáló) is alkalmazza az StructLayoutAttribute attribútumot; mindig a típustár importálásakor alkalmazza az LayoutKind.Sequential értéket.

Konstruktorok

Name	Description
StructLayoutAttribute(Int16)	Inicializálja az osztály új példányát StructLayoutAttribute a megadott LayoutKind enumerálási taggal.
StructLayoutAttribute(LayoutKind)	Inicializálja az osztály új példányát StructLayoutAttribute a megadott LayoutKind enumerálási taggal.

Mezők

Name	Description
CharSet	Azt jelzi, hogy az osztályon belüli sztringadatmezőket alapértelmezettként vagy LPSTR alapértelmezettként LPWSTR kell-e használni.
Pack	Egy osztály vagy struktúra adatmezőinek igazítását szabályozza a memóriában.
Size	Az osztály vagy struktúra abszolút méretét jelzi.

Tulajdonságok

Name	Description
TypeId	Ha származtatott osztályban implementálják, ehhez egy egyedi azonosítót Attributekap. (Öröklődés forrása Attribute)
Value	Lekéri az LayoutKind osztály vagy a struktúra elrendezését meghatározó értéket.

Metódusok

Name	Description
Equals(Object)	Olyan értéket ad vissza, amely jelzi, hogy ez a példány egyenlő-e egy adott objektummal. (Öröklődés forrása Attribute)
GetHashCode()	A példány kivonatkódját adja vissza. (Öröklődés forrása Attribute)
GetType()	Lekéri az Type aktuális példányt. (Öröklődés forrása Object)
IsDefaultAttribute()	Ha egy származtatott osztályban felül van bírálva, azt jelzi, hogy a példány értéke-e a származtatott osztály alapértelmezett értéke. (Öröklődés forrása Attribute)
Match(Object)	Származtatott osztály felülírásakor egy olyan értéket ad vissza, amely jelzi, hogy ez a példány egy adott objektummal egyenlő-e. (Öröklődés forrása Attribute)
MemberwiseClone()	Az aktuális Objectpéldány sekély másolatát hozza létre. (Öröklődés forrása Object)
ToString()	Az aktuális objektumot jelképező sztringet ad vissza. (Öröklődés forrása Object)

Explicit interfész-implementációk

Name	Description
_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Névkészletet képez le a küldési azonosítók megfelelő készletére. (Öröklődés forrása Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Lekéri egy objektum típusadatait, amelyek a felület típusadatainak lekérésére használhatók. (Öröklődés forrása Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Lekéri az objektumok által biztosított típusinformációs felületek számát (0 vagy 1). (Öröklődés forrása Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Hozzáférést biztosít az objektumok által közzétett tulajdonságokhoz és metódusokhoz. (Öröklődés forrása Attribute)

Lásd még

• Tlbimp.exe (típustár-importáló)