StructLayoutAttribute Class
Assembly: mscorlib (in mscorlib.dll)
'Declaration <ComVisibleAttribute(True)> _ <AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Struct, Inherited:=False)> _ Public NotInheritable Class StructLayoutAttribute Inherits Attribute 'Usage Dim instance As StructLayoutAttribute
/** @attribute ComVisibleAttribute(true) */ /** @attribute AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Struct, Inherited=false) */ public final class StructLayoutAttribute extends Attribute
ComVisibleAttribute(true) AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Struct, Inherited=false) public final class StructLayoutAttribute extends Attribute
Not applicable.
You can apply this attribute to classes or structures.
Typically, the common language runtime controls the physical layout of the data fields of a class or structure in managed memory. If the class or structure needs to be arranged a certain way, you can use StructLayoutAttribute. Explicit control of a class layout is important if the class is to be passed to unmanaged code that expects a specific layout. The LayoutKind value Sequential is used to force the members to be laid out sequentially in the order they appear. Explicit controls the precise position of each data member. With Explicit, each member must use the FieldOffsetAttribute to indicate the position of that field within the type.
C#, Visual Basic. NET, and C++ compilers apply the Sequential layout value to structures by default. For classes, you must apply the Sequential value explicitly. The Type Library Importer (Tlbimp.exe) also applies this attribute; it always applies the Sequential value when it imports a type library.
The following example demonstrates a managed declaration of the GetSystemTime function and defines MySystemTime class with LayoutKind.Explicit layout. The GetSystemTime gets the system time and prints to the console.
<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 'MySystemTime Class LibWrapper <DllImport("kernel32.dll")> _ Public Shared Sub GetSystemTime(<MarshalAs(UnmanagedType.LPStruct)> st As MySystemTime) End SUb End Class 'LibWrapper Class TestApplication Public Shared Sub Main() Try Dim sysTime As New MySystemTime() LibWrapper.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 'Main End Class 'TestApplication End Namespace 'InteropSample
/** @attribute StructLayout(LayoutKind.Explicit, Size = 16,
CharSet = CharSet.Ansi)
*/
public class MySystemTime
{
/** @attribute FieldOffset(0)
*/
public short wYear;
/** @attribute FieldOffset(2)
*/
public short wMonth;
/** @attribute FieldOffset(4)
*/
public short wDayOfWeek;
/** @attribute FieldOffset(6)
*/
public short wDay;
/** @attribute FieldOffset(8)
*/
public short wHour;
/** @attribute FieldOffset(10)
*/
public short wMinute;
/** @attribute FieldOffset(12)
*/
public short wSecond;
/** @attribute FieldOffset(14)
*/
public short wMilliseconds;
} //MySystemTime
class LibWrapper
{
/** @attribute DllImport("kernel32.dll")
*/
public static native void GetSystemTime(
/** @attribute MarshalAs(UnmanagedType.LPStruct)
*/
MySystemTime st);
} //LibWrapper
class TestApplication
{
public static void main(String[] args)
{
try {
MySystemTime sysTime = new MySystemTime();
LibWrapper.GetSystemTime(sysTime);
Console.WriteLine("The System time is {0}/{1}/{2} {3}:{4}:{5}",
new Object[] { (Int32)sysTime.wDay, (Int32)sysTime.wMonth,
(Int32)sysTime.wYear, (Int32)sysTime.wHour, (Int32)sysTime.
wMinute, (Int32)sysTime.wSecond });
}
catch (TypeLoadException e) {
Console.WriteLine("TypeLoadException : " + e.get_Message());
}
catch (System.Exception e) {
Console.WriteLine("Exception : " + e.get_Message());
}
} //main
} //TestApplication
Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.