System.Runtime.InteropServices.FieldOffsetAttribute Class

Summary

Indicates the physical position of fields within the unmanaged representation of a class or structure.

C# Syntax:

[AttributeUsage(AttributeTargets.Field)] public sealed class FieldOffsetAttribute : Attribute

You can apply this attribute to fields.

This attribute is used when StructLayoutAttribute, with LayoutKind.Explicit passed to its constructor, is applied to a class or structure to specify the offset of each non static or constant member within the unmanaged representation of that class or structure. The attribute has no affect on the managed layout of the members of the type.

 [StructLayout(LayoutKind.Explicit)]
 public class SYSTEM_INFO
 {
 [FieldOffset(0)] public ulong OemId;
 [FieldOffset(4)] public ulong PageSize;
 [FieldOffset(16)] public ulong ActiveProcessorMask;
 [FieldOffset(20)] public ulong NumberOfProcessors;
 [FieldOffset(24)] public ulong ProcessorType;
 }

    

System.Runtime.InteropServices Namespace | StructLayoutAttribute | LayoutKind

System.Runtime.InteropServices.FieldOffsetAttribute Member List:

Public Constructors

ctor #1

Initializes a new instance of the FieldOffsetAttribute class with the offset in the structure to the beginning of the field.

Public Properties

TypeId (inherited from System.Attribute)	Read-only See base class member description: System.Attribute.TypeId When implemented in a derived class, gets a unique identifier for this Attribute.
Value	Read-only Gets the offset from the beginning of the structure to the beginning of the field.

Public Methods

Equals (inherited from System.Object)	See base class member description: System.Object.Equals Derived from System.Object, the primary base class for all objects.
GetHashCode (inherited from System.Attribute)	See base class member description: System.Attribute.GetHashCode Returns the hash code for this instance.
GetType (inherited from System.Object)	See base class member description: System.Object.GetType Derived from System.Object, the primary base class for all objects.
IsDefaultAttribute (inherited from System.Attribute)	See base class member description: System.Attribute.IsDefaultAttribute When overridden in a derived class, returns an indication whether the value of this instance is the default value for the derived class.
Match (inherited from System.Attribute)	See base class member description: System.Attribute.Match When overridden in a derived class, returns a value indicating whether this instance equals a specified object.
ToString (inherited from System.Object)	See base class member description: System.Object.ToString Derived from System.Object, the primary base class for all objects.

Protected Methods

Finalize (inherited from System.Object)	See base class member description: System.Object.Finalize Derived from System.Object, the primary base class for all objects.
MemberwiseClone (inherited from System.Object)	See base class member description: System.Object.MemberwiseClone Derived from System.Object, the primary base class for all objects.

Hierarchy:

• System.Object
• System.Attribute
• System.Runtime.InteropServices.FieldOffsetAttribute

System.Runtime.InteropServices.FieldOffsetAttribute Member Details

Summary

Initializes a new instance of the FieldOffsetAttribute class with the offset in the structure to the beginning of the field.

C# Syntax:

public FieldOffsetAttribute(    int offset );

offset

The offset in bytes from the beginning of the structure to the beginning of the field.

Return to top

Inherited
See base class member description: System.Attribute.TypeId

Summary

When implemented in a derived class, gets a unique identifier for this Attribute.

C# Syntax:

public virtual object TypeId {get;}

As implemented, this identifier is merely the Type of the attribute. However, it is intended that the unique identifier be used to identify two attributes of the same type.

Return to top

Summary

Gets the offset from the beginning of the structure to the beginning of the field.

C# Syntax:

public int Value {get;}

Return to top

Inherited
See base class member description: System.Object.Equals

C# Syntax:

public virtual bool Equals(    object obj );

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.Finalize

C# Syntax:

~FieldOffsetAttribute();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Attribute.GetHashCode

Summary

Returns the hash code for this instance.

C# Syntax:

public override int GetHashCode();

Return Value:

A 32-bit signed integer hash code.

Return to top

Inherited
See base class member description: System.Object.GetType

C# Syntax:

public Type GetType();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Attribute.IsDefaultAttribute

Summary

When overridden in a derived class, returns an indication whether the value of this instance is the default value for the derived class.

C# Syntax:

public virtual bool IsDefaultAttribute();

Return Value:

true if this instance is the default attribute for the class; otherwise, false.

The default implementation of this class returns false, and must be implemented in the derived class to be useful to that class.

The implementation of this method in a derived class compares the value of this instance to a standard, default value obtained by some means, then returns a Boolean value that indicates whether the value of this instance is equal to the standard. The standard value is typically coded as a constant in the implementation, or stored programmatically in a field used by the implementation.

Return to top

Inherited
See base class member description: System.Attribute.Match

Summary

When overridden in a derived class, returns a value indicating whether this instance equals a specified object.

C# Syntax:

public virtual bool Match(    object obj );

obj

An Object to compare with this instance of Attribute.

Return Value:

true if this instance equals obj; otherwise, false.

This method determines if one Attribute equals another. Its default implementation is the same as Attribute.Equals, which performs a value and reference comparison. Override this method to implement support for attribute values, such as flags or bitfields, that consist of components that are meaningful in themselves. For example, consider an attribute whose value is a binary field divided into a bitfield of flags. Two instances of this attribute have one flag in set in common while all the other flags differ. The Equal method cannot determine that the two instances have the same flag set, but the Match method can.

Return to top

Inherited
See base class member description: System.Object.MemberwiseClone

C# Syntax:

protected object MemberwiseClone();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.ToString

C# Syntax:

public virtual string ToString();

For more information on members inherited from System.Object click on the link above.

Return to top

Top of page