AcxTargetElementFormatRequestForMethod function (acxtargets.h)

Article
10/03/2023

The AcxTargetElementFormatRequestForMethod function formats a WDFREQUEST as an ACX method request to be used on specified element target.

Syntax

NTSTATUS AcxTargetElementFormatRequestForMethod(
  ACXTARGETELEMENT        TargetElement,
  WDFREQUEST              Request,
  PACX_REQUEST_PARAMETERS Params
);

Parameters

TargetElement

An ACXTARGETELEMENT handle. For more information about ACX objects, see Summary of ACX Objects.

Request

A WDFREQUEST handle described in Summary of Framework Objects. For general information about WDF requests, see Creating Framework Request Objects.

Params

An initialized ACX_REQUEST_PARAMETERS structure that is used to store method request parameter information.

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

A WDFREQUEST is a driver created I/O requests. Framework-based drivers process each I/O request by calling framework request object methods. For more information, see Framework Request Objects.

Example

This sample code shows the use of the AcxTargetElementFormatRequestForMethod.


    {
        ACXTARGETELEMENT targetElement          = NULL;
        ULONG            targetElementId        = 0;
        ULONG            targetElementsCount    = AcxTargetCircuitGetElementsCount(TargetCircuit);
        arg     = elementArg;
        result  = 0;

        targetElement = AcxTargetCircuitGetTargetElement(TargetCircuit, targetElementId);       

        ACX_REQUEST_PARAMETERS_INIT_METHOD(
            &params,
            KSMETHODSETID_AcxTestMethod,
            KSMETHOD_ACXELEMENT_TEST_IN2OUT,
            AcxMethodVerbSend,
            AcxItemTypeElement,
            targetElementId,
            &arg, sizeof(arg),      // Value & size
            &result, sizeof(result) // Control & size
            );  

        //
        // Format a WDF request as an ACX method request for the ACX element target.
        //
        status = AcxTargetElementFormatRequestForMethod(targetElement, req, &params);

ACX requirements

Minimum ACX version: 1.0

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

Requirements

Requirement	Value
Header	acxtargets.h
IRQL	PASSIVE_LEVEL

Share via