SpbRequestComplete function (spbcx.h)

Article
02/22/2024

The SpbRequestComplete method completes an I/O request and supplies a completion status.

Syntax

void SpbRequestComplete(
  [in] SPBREQUEST Request,
  [in] NTSTATUS   CompletionStatus
);

Parameters

[in] Request

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

[in] CompletionStatus

An NTSTATUS value that represents the completion status of the request. Valid status values include, but are not limited to, the following:

STATUS_SUCCESS

The I/O request completed successfully.

STATUS_CANCELLED

The I/O request is canceled.

STATUS_UNSUCCESSFUL

The driver encountered an error while processing the I/O request.

Return value

None

Remarks

Your controller driver calls this method to complete an I/O request that it previously received during one of the following callbacks:

EvtSpbControllerIoOther EvtSpbControllerIoRead EvtSpbControllerIoSequence EvtSpbControllerIoWrite Call SpbRequestComplete instead of the WdfRequestComplete method to complete I/O requests received by the callback functions in the preceding list.

A bug check occurs if the caller supplies an invalid SPBREQUEST handle.

A call to SpbRequestComplete represents the final stage in the processing of an I/O request. When this method returns, the Request handle value is no longer valid.

Requirements

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