| UID | title | description | old-location | 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:ehstorbandmgmt._ERASE_BAND_PARAMETERS |
_ERASE_BAND_PARAMETERS (ehstorbandmgmt.h) |
The ERASE_BAND_PARAMETERS structure contains the selection criteria for a band to erase. Additionally, a new authentication key can be set. This structure is input for an IOCTL_EHSTOR_BANDMGMT_ERASE_BAND request. |
storage\erase_band_parameters.htm |
storage |
03/29/2018 |
|
*PERASE_BAND_PARAMETERS, ERASEBAND_AUTHKEY_CACHING_ENABLED, ERASE_BAND_PARAMETERS, ERASE_BAND_PARAMETERS structure [Storage Devices], PERASE_BAND_PARAMETERS, PERASE_BAND_PARAMETERS structure pointer [Storage Devices], _ERASE_BAND_PARAMETERS, ehstorbandmgmt/ERASE_BAND_PARAMETERS, ehstorbandmgmt/PERASE_BAND_PARAMETERS, storage.erase_band_parameters |
ehstorbandmgmt.h |
EhStorBandMgmt.h |
Windows |
Available starting with Windows 8 |
Windows |
ERASE_BAND_PARAMETERS, *PERASE_BAND_PARAMETERS |
|
|
|
|
|
The ERASE_BAND_PARAMETERS structure contains the selection criteria for a band to erase. Additionally, a new authentication key can be set. This structure is input for an IOCTL_EHSTOR_BANDMGMT_ERASE_BAND request.
The size of this structure in bytes. Set to sizeof(ERASE_BAND_PARAMETERS).
Delete operation flags. This value is a bitwise OR combination of the following.
| Value | Meaning |
|---|---|
|
The new authentication key for this band is cached allowing for automation of later operations. |
Reserved.
The identifier of a single band to return information for. BandSize must be 0 when a single band is selected with BandId. To use BandStart and BandSize instead of BandId to select a band, set BandId = (ULONG) –1.
The starting byte location on the storage device to begin a band search. An attempt is made to match a band at or after BandStart.
The offset, in bytes, of an AUTH_KEY structure containing the new authorization key for the band. The offset is from the beginning of ERASE_BAND_PARAMETERS. AUTH_KEY is declared in ehstorbandmgmt.h as the following.
typedef struct _AUTH_KEY
{
ULONG KeySize;
UCHAR Key[ANYSIZE_ARRAY];
} AUTH_KEY;
The size of the key, in bytes, of the key data at Key. If KeySize is set to 0, a default key is used.
A variable-length byte array that contains the key data.
To specify a default authentication key to the band, set NewAuthKeyOffset = EHSTOR_BANDMGR_NO_KEY.
Precedence is given to BandID for band selection. If BandID is greater than 0 and BandID is less than the MaxBandCount member of BAND_MANAGEMENT_CAPABILITIES, then BandID is used as the only selection criteria for a band match. If BandID == –1, then BandStart is used as the match criteria to select a band. If no band matches either selection criteria, then STATUS_INVALID_PARAMETER is returned in the IoStatus block for IOCTL_EHSTOR_BANDMGMT_ERASE_BAND.
.