IOCTL_EHSTOR_BANDMGMT_SET_BAND_METADATA control code

Metadata associated with a band is set with an IOCTL_EHSTOR_BANDMGMT_SET_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 SET_BAND_METADATA_PARAMETERS and possibly an AUTH_KEY structure along with the new metadata to set for the band. Parameters.DeviceIoControl.InputBufferLength indicates the size, in bytes, of the buffer, which must be at least sizeof (SET_BAND_METADATA_PARAMETERS) + MetadataSize + sizeof(AUTH_KEY).

If the AuthKeyOffset member of SET_BAND_METADATA_PARAMETERS is set to EHSTOR_BANDMGR_NO_KEY, the input data in the system buffer need not include an AUTH_KEY structure.

Output Parameters

None.

I/O Status Block

One of the following values may be returned in the Status field:

Status ValueDescription
STATUS_SUCCESSThe metadata was set for the selected band.
STATUS_INVALID_DEVICE_REQUESTStorage device does not support band management.
STATUS_INVALID_BUFFER_SIZEThe input buffer size is incorrect.
STATUS_INVALID_PARAMETERInformation in the input buffer is invalid.
STATUS_NOT_FOUNDBand was not found for the selection criteria provided.
STATUS_IO_DEVICE_ERRORCommunication failed. The storage device might be incompatible with security protocols.

 

Remarks

Metadata can also be erased by using this IOCTL. To erase metadata for a band, set the metadata portion of input buffer to all zeros or some other erase pattern. To ensure removal of sensitive information in metadata blobs, this erase operation should be performed prior to deleting a band from the silo driver's band table.

Requirements

Version

Available in Windows 8 and later versions of Windows.

Header

EhStorBandMgmt.h (include EhStorBandMgmt.h)

See also

SET_BAND_METADATA_PARAMETERS

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft