PackingSize PackingSize PackingSize PackingSize Enum

Definition

Specifies one of two factors that determine the memory alignment of fields when a type is marshaled.

This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

public enum class PackingSize
[System.Runtime.InteropServices.ComVisible(true)]
[System.Flags]
public enum PackingSize
type PackingSize = 
Public Enum PackingSize
Inheritance
Attributes

Fields

Size1 Size1 Size1 Size1 1

The packing size is 1 byte.

Size128 Size128 Size128 Size128 128

The packing size is 128 bytes.

Size16 Size16 Size16 Size16 16

The packing size is 16 bytes.

Size2 Size2 Size2 Size2 2

The packing size is 2 bytes.

Size32 Size32 Size32 Size32 32

The packing size is 32 bytes.

Size4 Size4 Size4 Size4 4

The packing size is 4 bytes.

Size64 Size64 Size64 Size64 64

The packing size is 64 bytes.

Size8 Size8 Size8 Size8 8

The packing size is 8 bytes.

Unspecified Unspecified Unspecified Unspecified 0

The packing size is not specified.

Remarks

Packing size affects the alignment of fields in structures and classes whose organization is LayoutKind.Sequential. The packing size is one of two factors that determine the offset of a field when the structure or class is marshaled; the other factor is the effective size of the field. To determine the offset of a field:

  1. Compute the minimum value for the offset by adding the size of the preceding field to the offset of the preceding field.

  2. Compute the natural packing size for the field: If the field is a simple data type, use the size. If the field is an array, use the size of an array element. If the field is itself a structure, compare the packing size of that structure to the size of the largest field in that structure, and use the smaller of the two values.

  3. Compute the effective packing size by comparing the packing size to the natural packing size of the field, computed in step 2. Use the smaller of the two numbers.

  4. Compute the offset. The offset is the first memory location that is equal to or larger than the minimum, and a multiple of the effective packing size computed in step 3.

Note

Once offsets have been computed for all the fields in the class or structure, padding is added so that the overall size is a multiple of the packing size.

For example, in a class containing a byte and a long, using packing size Size1, the offset of the byte field is zero (0) and the offset of the long field is one (1). If the packing size is Size4, the long field has offset four (4). In a class containing two short fields, using any packing size, the offset of the second short field is two (2).

Note

Changing the packing size can affect performance if it causes fields to be aligned on offsets that are not multiples of their size.

Applies to