IOCTL_EHSTOR_BANDMGMT_REVERT control code

This IOCTL_EHSTOR_BANDMGMT_REVERT request is sent to deactivate the security features and band management on a storage device. The request includes revert options and the authentication key.

Input Parameters

The input buffer at Irp->AssociatedIrp.SystemBuffer contains an ACTIVATE_REVERT_PARAMETERS structure. ACTIVATE_REVERT_PARAMETERS is declared in ehstorbandmgmt.h as the following.


typedef struct _ACTIVATE_REVERT_PARAMETERS
{
    ULONG           StructSize;
    ULONG           Flags;
    ULONG           AuthKeyOffset;
} ACTIVATE_REVERT_PARAMETERS;

StructSize

The size of the structure. This is set to sizeof(ACTIVATE_REVERT_PARAMETERS).

Flags

A bitmask of deactivation flags. This is a bitwise OR value of the following.

FlagDescription
REVERT_PSID_AUTHKEYThe authentication key at AuthKeyOffset is a PSID key.

 

AuthKeyOffset

The offset from the beginning of the system buffer to the location of an AUTH_KEY structure.

Following ACTIVATE_REVERT_PARAMETERS in the system buffer is an AUTH_KEY structure. This holds the key data bytes for the authentication key. AUTH_KEY is declared in ehstorbandmgmt.h as the following.


typedef struct _AUTH_KEY
{
    ULONG   KeySize;
    UCHAR   Key[ANYSIZE_ARRAY];
} AUTH_KEY;

KeySize

The size of the key, in bytes, of the key data at Key. If KeySize is set to 0, a default key is used.

Key

A variable length byte array that contains the key data.

Output Parameters

None.

I/O Status Block

One of the following values can be returned in the Status field.

Status ValueDescription
STATUS_SUCCESSSecurity features on the storage device were deactivated.
STATUS_INVALID_DEVICE_REQUESTThe storage device does not support band management.
STATUS_INVALID_BUFFER_SIZEThe input buffer size is invalid.
STATUS_INVALID_PARAMETERInformation in the input buffer is invalid.
STATUS_ACCESS_DENIEDThe authentication key is invalid. Deactivation is denied.
STATUS_DEVICE_CONFIGURATION_ERRORThe system cannot configure the device in a supported mode.
STATUS_IO_DEVICE_ERRORCommunication failed. The storage device might be incompatible with security protocols.
STATUS_INVALID_DEVICE_STATEThe storage device is not activated.

 

Remarks

On successful return from an IOCTL_EHSTOR_BANDMGMT_REVERT request, the storage device will return to an inactive security state and all band management IOCTLs, except for IOCTL_EHSTOR_BANDMGMT_QUERY_CAPABILITIES and IOCTL_EHSTOR_BANDMGMT_ACTIVATE, become unavailable.

Requirements

Version

Available starting with Windows 8

Header

EhStorBandMgmt.h (include EhStorBandMgmt.h)

See also

IOCTL_EHSTOR_BANDMGMT_ACTIVATE
IOCTL_EHSTOR_BANDMGMT_QUERY_CAPABILITIES

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft