AcxTargetPinFormatRequestForMethod function (acxtargets.h)

Article
2024-02-22

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

Syntax

NTSTATUS AcxTargetPinFormatRequestForMethod(
  ACXTARGETPIN            TargetPin,
  WDFREQUEST              Request,
  PACX_REQUEST_PARAMETERS Params
);

Parameters

TargetPin

An existing ACXTARGETPIN object. 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

...
    _In_    ACXTARGETCIRCUIT TargetCircuit,
    _In_    ULONG            TargetPinId
    )

    NTSTATUS                    status;
    WDFREQUEST                  req;
    ACX_REQUEST_PARAMETERS      params;
    ACXTARGETPIN                targetPin = NULL;

...

    //
    // Get the target pin obj.
    //
    targetPin = AcxTargetCircuitGetTargetPin(TargetCircuit, TargetPinId);

    //
    // Format a WDF request for the target.
    //
    status = AcxTargetPinFormatRequestForMethod(targetPin, 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