StructLayoutAttribute Classe

Définition

Espace de noms:

System.Runtime.InteropServices

Assembly:

System.Runtime.dll

Source:

StructLayoutAttribute.cs

Vous permet de contrôler la disposition physique des champs de données d'une classe ou d'une structure en mémoire.

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

Héritage

Object

Attribute

StructLayoutAttribute

Attributs

AttributeUsageAttribute

Exemples

L’exemple suivant illustre une déclaration managée de la fonction et définit MySystemTime la GetSystemTime classe avec LayoutKind.Explicit disposition. GetSystemTime obtient l’heure système et s’imprime sur la 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

Remarques

Vous pouvez appliquer cet attribut à des classes ou des structures.

Le Common Language Runtime contrôle la disposition physique des champs de données d’une classe ou d’une structure dans la mémoire managée. Toutefois, si vous souhaitez passer le type au code non managé, vous pouvez utiliser l’attribut StructLayoutAttribute pour contrôler la disposition non managée du type. Utilisez l’attribut avec LayoutKind.Sequential pour forcer les membres à être disposés séquentiellement dans l’ordre dans lequel ils apparaissent. Pour les types blittables, LayoutKind.Sequential contrôle à la fois la disposition en mémoire managée et la disposition dans la mémoire non managée. Pour les types non blittables, il contrôle la disposition lorsque la classe ou la structure est marshalée en code non managé, mais ne contrôle pas la disposition dans la mémoire managée. Utilisez l’attribut avec LayoutKind.Explicit pour contrôler la position précise de chaque membre de données. Cela affecte à la fois la disposition managée et non managée, pour les types blittable et non blittable. L’utilisation LayoutKind.Explicit nécessite l’utilisation de l’attribut FieldOffsetAttribute pour indiquer la position de chaque champ dans le type.

Les compilateurs C#, Visual Basic et C++ appliquent la valeur de disposition Sequential aux structures par défaut. Pour les classes, vous devez appliquer la LayoutKind.Sequential valeur explicitement. Tlbimp.exe (importateur de bibliothèque de types) applique également l’attribut StructLayoutAttribute ; il applique toujours la LayoutKind.Sequential valeur lorsqu’il importe une bibliothèque de types.

Constructeurs

StructLayoutAttribute(Int16)	Initialise une nouvelle instance de la classe StructLayoutAttribute avec le membre de l'énumération LayoutKind spécifié.
StructLayoutAttribute(LayoutKind)	Initialise une nouvelle instance de la classe StructLayoutAttribute avec le membre de l'énumération LayoutKind spécifié.

Champs

CharSet	Indique si les champs de données de type chaîne de la classe doivent être marshalés en tant que LPWSTR ou LPSTR par défaut.
Pack	Contrôle l'alignement des champs de données d'une classe ou d'une structure en mémoire.
Size	Indique la taille absolue de la classe ou la structure.

Propriétés

TypeId	Lors de l'implémentation dans une classe dérivée, obtient un identificateur unique pour l'objet Attribute. (Hérité de Attribute)
Value	Obtient la valeur LayoutKind qui spécifie la façon dont la classe ou la structure est disposée.

Méthodes

Equals(Object)	Retourne une valeur qui indique si cette instance est égale à un objet spécifié. (Hérité de Attribute)
GetHashCode()	Retourne le code de hachage de cette instance. (Hérité de Attribute)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
IsDefaultAttribute()	En cas de substitution dans une classe dérivée, indique si la valeur de cette instance est la valeur par défaut pour la classe dérivée. (Hérité de Attribute)
Match(Object)	En cas de substitution dans une classe dérivée, retourne une valeur indiquant si cette instance équivaut à un objet spécifié. (Hérité de Attribute)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)

Voir aussi

• Tlbimp.exe (Type Library Importer)