Edit

GET_BAND_METADATA_PARAMETERS structure (ehstorbandmgmt.h)

  • Article

The metadata for a configured band is retrieved according to the parameters in a GET_BAND_METADATA_PARAMETERS structure. This structure is input for an IOCTL_EHSTOR_BANDMGMT_GET_BAND_METADATA request.

Syntax

typedef struct _GET_BAND_METADATA_PARAMETERS {
  ULONG         StructSize;
  ULONG         BandId;
  LARGE_INTEGER BandStart;
  ULONG         MetadataOffset;
  ULONG         MetadataSize;
} GET_BAND_METADATA_PARAMETERS, *PGET_BAND_METADATA_PARAMETERS;

Members

StructSize

The size of this structure in bytes. Set to sizeof(GET_BAND_METADATA_PARAMETERS).

BandId

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.

BandStart

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.

MetadataOffset

The offset from the start of the band metadata property to retrieve data from.

MetadataSize

The length of metadata bytes to retrieve.

Remarks

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_GET_BAND_METADATA.

If BandID and BandStart are both set to –1, then the IOCTL_EHSTOR_BANDMGMT_GET_BAND_METADATA returns metadata for the global band.

If IOCTL_EHSTOR_BANDMGMT_GET_BAND_METADATA was successful, Parameters.DeviceIoControl.InputBufferLength equals the value in MetadataSize.

Requirements

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

See also

BAND_MANAGEMENT_CAPABILITIES

IOCTL_EHSTOR_BANDMGMT_GET_BAND_METADATA