Skip to content

Latest commit

 

History

History
92 lines (67 loc) · 3.23 KB

ns-scsi-populate_token_header.md

File metadata and controls

92 lines (67 loc) · 3.23 KB
UID title description tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NS:scsi.POPULATE_TOKEN_HEADER
POPULATE_TOKEN_HEADER (scsi.h)
The POPULATE_TOKEN_HEADER structure (scsi.h) contains the header for the parameters in a command data block (CDB) of the POPULATE TOKEN command.
storage
09/19/2022
POPULATE_TOKEN_HEADER structure
*PPOPULATE_TOKEN_HEADER, POPULATE_TOKEN_HEADER, POPULATE_TOKEN_HEADER structure [Storage Devices], PPOPULATE_TOKEN_HEADER, PPOPULATE_TOKEN_HEADER structure pointer [Storage Devices], scsi/POPULATE_TOKEN_HEADER, scsi/PPOPULATE_TOKEN_HEADER, storage.populate_token_header
scsi.h
Scsi.h, Minitape.h, Storport.h
Windows
Available starting with Windows 8.
Windows
POPULATE_TOKEN_HEADER, *PPOPULATE_TOKEN_HEADER
PPOPULATE_TOKEN_HEADER
scsi/PPOPULATE_TOKEN_HEADER
POPULATE_TOKEN_HEADER
scsi/POPULATE_TOKEN_HEADER
APIRef
kbSyntax
HeaderDef
scsi.h
PPOPULATE_TOKEN_HEADER
POPULATE_TOKEN_HEADER

-description

A populate token parameter list starts with a POPULATE_TOKEN_HEADER structure. This is the header for the parameters in a command data block (CDB) of the POPULATE TOKEN command.

-struct-fields

-field PopulateTokenDataLength

The length of this structure beginning with the Immediate parameter and include all of the elements of the BlockDeviceRangeDescriptor array.

-field Immediate

If set, the status of the POPULATE TOKEN command is returned immediately after receipt and validation of the range descriptors. Otherwise, status is returned after all command processing is complete.

-field Reserved1

Reserved bits.

-field Reserved2

Reserved.

-field InactivityTimeout

The timeout duration for which the copy provider waits for the next command using the token created for this representation of data (ROD). The validity of the token created for the ROD described by this structure expires at this timeout value.

-field Reserved3

Reserved.

-field BlockDeviceRangeDescriptorListLength

The length, in bytes, for all of the BLOCK_DEVICE_RANGE_DESCRIPTOR structures in the BlockDeviceRangeDescriptor array.

-field BlockDeviceRangeDescriptor

An array of BLOCK_DEVICE_RANGE_DESCRIPTOR structures which describe the logical blocks representing the file being read from the LUN.

-remarks

The POPULATE_TOKEN_HEADER structure contains a series of BLOCK_DEVICE_RANGE_DESCRIPTOR structures which describe the token ROD.

All multibyte values are in big endian format. Prior to setting, these values must be converted from the endian format of the current platform.

-see-also

BLOCK_DEVICE_RANGE_DESCRIPTOR