IOCTL_EHSTOR_BANDMGMT_GET_BAND_METADATA control code

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.

Input Parameters

The input buffer at Irp->AssociatedIrp.SystemBuffer must contain a GET_BAND_METADATA_PARAMETERS structure. Parameters.DeviceIoControl.InputBufferLength indicates the size, in bytes, of the buffer, which must be at least sizeof (GET_BAND_METADATA_PARAMETERS).

Output Parameters

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

I/O 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 ValueDescription
STATUS_SUCCESSThe metadata was returned in the system buffer.
STATUS_INVALID_DEVICE_REQUESTThe storage device does not support band management.
STATUS_INVALID_BUFFER_SIZEThe output buffer size is incorrect.
STATUS_INVALID_PARAMETERInformation in the input buffer is invalid.
STATUS_NOT_FOUNDThe band was not found for the selection criteria provided.
STATUS_IO_DEVICE_ERRORCommunication 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

Version

Available starting with Windows 8

Header

EhStorBandMgmt.h (include EhStorBandMgmt.h)

See also

BAND_LOCATION_INFO
BAND_SECURITY_INFO
CREATE_BAND_PARAMETERS

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft