SpbRequestGetParameters function (spbcx.h)

Article
10/21/2021

The SpbRequestGetParameters method retrieves a set of SPB-specific parameter values from an I/O request.

Syntax

void SpbRequestGetParameters(
  [in]  SPBREQUEST             SpbRequest,
  [out] SPB_REQUEST_PARAMETERS *Parameters
);

Parameters

[in] SpbRequest

An SPBREQUEST handle to the I/O request. The SPB controller driver previously received this handle through one of its registered event callback functions.

[out] Parameters

A pointer to a caller-allocated SPB_REQUEST_PARAMETERS structure into which the method writes the SPB-specific parameter values from the I/O request. The caller must have previously initialized this structure by calling the SPB_REQUEST_PARAMETERS_INIT function.

Return value

None

Remarks

SpbRequestGetParameters is similar to the WdfRequestGetParameters method, but retrieves only SPB-specific information. Your SPB controller driver can call SpbRequestGetParameters to retrieve SPB-specific information from I/O requests that it receives from the SPB framework extension (SpbCx). The SPB controller driver can call WdfRequestGetParameters to retrieve the generic request parameters from I/O requests that it receives.

Examples

The following code example shows how to use SpbRequestGetParameters to retrieve the SPB-specific parameters from an I/O request. The spbRequest variable contains an SPBREQUEST handle to the I/O request.

SPB_REQUEST_PARAMETERS parameters;

SPB_REQUEST_PARAMETERS_INIT(&parameters);

SpbRequestGetParameters(spbRequest, &parameters);

Requirements

Requirement	Value
Minimum supported client	Available starting with Windows 8.
Target Platform	Universal
Header	spbcx.h
Library	Spbcxstubs.lib
IRQL	<= DISPATCH_LEVEL