IOCTL_EHSTOR_BANDMGMT_GET_BAND_METADATA IOCTL (ehstorbandmgmt.h)

Metadata associated with a band is retrieved with an IOCTL_EHSTOR_BANDMGMT_GET_BAND_METADATA request. The metadata for a band serves as a data area for a key manager application.

Major code

IRP_MJ_DEVICE_CONTROL

Input buffer

The input buffer at Irp->AssociatedIrp.SystemBuffer must contain a GET_BAND_METADATA_PARAMETERS structure.

Input buffer length

Parameters.DeviceIoControl.InputBufferLength indicates the size, in bytes, of the buffer, which must be at least sizeof (GET_BAND_METADATA_PARAMETERS).

Output buffer

The output buffer at Irp->AssociatedIrp.SystemBuffer contains a byte array of band metadata specified by GET_BAND_METADATA_PARAMETERS.

Output buffer length

The length of a GET_BAND_METADATA_PARAMETERS structure.

Status block

The Information field contains the number of bytes returned in the output buffer. One of the following values can be returned in the Status field.

Status Value Description
STATUS_SUCCESS The metadata was returned in the system buffer.
STATUS_INVALID_DEVICE_REQUEST The storage device does not support band management.
STATUS_INVALID_BUFFER_SIZE The output buffer size is incorrect.
STATUS_INVALID_PARAMETER Information in the input buffer is invalid.
STATUS_NOT_FOUND The band was not found for the selection criteria provided.
STATUS_IO_DEVICE_ERROR Communication failed. The storage device might be incompatible with security protocols.

Remarks

Authentication for this IOCTL is unnecessary and an authentication key is not included as input.

Requirements

Requirement Value
Minimum supported client Available starting with Windows 8
Header ehstorbandmgmt.h (include EhStorBandMgmt.h)

See also

BAND_LOCATION_INFO

BAND_SECURITY_INFO

CREATE_BAND_PARAMETERS