Edit

STORAGE_OFFLOAD_TOKEN structure (winioctl.h)

  • Article

Contains the token used to represent a portion of a file used in by offload read and write operations specified by DeviceDsmAction_OffloadRead or DeviceDsmAction_OffloadWrite actions for the IOCTL_STORAGE_MANAGE_DATA_SET_ATTRIBUTES control code.

Syntax

typedef struct _STORAGE_OFFLOAD_TOKEN {
  BYTE  TokenType[4];
  BYTE  Reserved[2];
  BYTE  TokenIdLength[2];
  union {
    struct {
      BYTE Reserved2[STORAGE_OFFLOAD_TOKEN_ID_LENGTH];
    } StorageOffloadZeroDataToken;
    BYTE Token[STORAGE_OFFLOAD_TOKEN_ID_LENGTH];
  } DUMMYUNIONNAME;
} STORAGE_OFFLOAD_TOKEN, *PSTORAGE_OFFLOAD_TOKEN;

Members

TokenType[4]

A 32-bit unsigned integer which defines the type of Token.

STORAGE_OFFLOAD_TOKEN_TYPE_WELL_KNOWN (0xFFFFFFFF)

The Token member uses a well-known format. The first two bytes of the Token member are a 16-bit unsigned integer that describes the region. The possible values are either STORAGE_OFFLOAD_PATTERN_ZERO or STORAGE_OFFLOAD_PATTERN_ZERO_WITH_PROTECTION_INFO. STORAGE_OFFLOAD_PATTERN_ZERO (0x0001) is a well-known token that indicates that the region represented has all bits set to zero. STORAGE_OFFLOAD_PATTERN_ZERO_WITH_PROTECTION_INFO is a well-known token that indicates that the data in the region represented has all bits set to zero and the corresponding protection information is valid.

0x00000000–0xFFFFFFFE

The Token member uses a vendor-specific format.

Reserved[2]

Reserved.

TokenIdLength[2]

The length of the token data in Token.

DUMMYUNIONNAME

DUMMYUNIONNAME.StorageOffloadZeroDataToken

DUMMYUNIONNAME.StorageOffloadZeroDataToken.Reserved2[STORAGE_OFFLOAD_TOKEN_ID_LENGTH]

Reserved.

DUMMYUNIONNAME.Token[STORAGE_OFFLOAD_TOKEN_ID_LENGTH]

If the TokenType member is STORAGE_OFFLOAD_TOKEN_TYPE_WELL_KNOWN then the first two bytes are a 16-bit unsigned integer that describes the range. Otherwise this is a vendor-specific format.

Requirements

Requirement Value
Minimum supported client Windows 8
Minimum supported server Windows Server 2012
Header winioctl.h (include Windows.h)