Edit

AcxStreamDispatchAcxRequest function (acxstreams.h)

  • Article

The AcxStreamDispatchAcxRequest dispatches an ACX request using a WDFREQUEST framework request object. AcxStreamDispatchAcxRequest is called within the context of an EVT_ACX_OBJECT_PREPROCESS_REQUEST event handler registered through AcxStreamInitAssignAcxRequestPreprocessCallback to indicate the request should be handled by the ACX framework.

Syntax

NTSTATUS AcxStreamDispatchAcxRequest(
  ACXSTREAM  Stream,
  WDFREQUEST Request
);

Parameters

Stream

An existing ACXSTREAM Object. An ACXSTREAM object represents an audio stream created by a circuit. For more information, see ACX - Summary of ACX Objects.

Request

The WDFREQUEST object handle that was passes to the EVT_ACX_OBJECT_PREPROCESS_REQUEST event handler. For general information about WDF requests, see Creating Framework Request Objects.

Return value

Returns STATUS_SUCCESS if the call was successful. Otherwise, it returns an appropriate error code. For more information, see Using NTSTATUS Values.

Remarks

For any call to the driver's EVT_ACX_OBJECT_PREPROCESS_REQUEST for an AcxStream object, the driver should either call WdfRequestComplete or AcxStreamDispatchAcxRequest, but not both.

Example

Example usage is shown below.

VOID
Codec_EvtStreamRequestPreprocess(
    _In_    ACXOBJECT  Object,
    _In_    ACXCONTEXT DriverContext,
    _In_    WDFREQUEST Request
    )
/*++

Routine Description:

    This function is an example of a preprocess routine.

--*/
{
    //
    // Just give the request back to ACX. Normally the driver would take steps to examine
    // the Request and take action if necessary.
    //
    AcxStreamDispatchAcxRequest((ACXSTREAM)Object, Request);
}

ACX requirements

Minimum ACX version: 1.0

For more information about ACX versions, see ACX version overview.

Requirements

Requirement Value
Header acxstreams.h
IRQL PASSIVE_LEVEL

See also