AcxTargetCircuitCreate function (acxtargets.h)

The AcxTargetCircuitCreate function is used to create an ACX target circuit.

Syntax

NTSTATUS AcxTargetCircuitCreate(
  WDFDEVICE                  Device,
  PWDF_OBJECT_ATTRIBUTES     Attributes,
  PACX_TARGET_CIRCUIT_CONFIG Config,
  ACXTARGETCIRCUIT           *TargetCircuit
);

Parameters

Device

A WDFDEVICE object (described in Summary of Framework Objects) that is associated with the specified ACXCIRCUIT.

Attributes

Additional Attributes defined using a WDF_OBJECT_ATTRIBUTES structure that are used to set various object's values: cleanup and destroy callbacks, context type, and to specify its parent object.

Config

An initialized ACX_TARGET_CIRCUIT_CONFIG structure that describes the configuration of the target circuit.

TargetCircuit

A pointer to a ___location that receives a handle to the new ACXTARGETCIRCUIT Object. For more information about ACX objects, see Summary of ACX 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

Example

    ACX_TARGET_CIRCUIT_CONFIG targetCfg;
    ACX_TARGET_CIRCUIT_CONFIG_INIT(&targetCfg);
    targetCfg.SymbolicLinkName = link;

    WDF_OBJECT_ATTRIBUTES_INIT(&attributes);
    attributes.ParentObject = Circuit;

    RETURN_NTSTATUS_IF_FAILED(AcxTargetCircuitCreate(AcxCircuitGetWdfDevice(Circuit), &attributes, &targetCfg, TargetCircuit));

ACX requirements

Minimum ACX version: 1.0

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

Requirements

See also

• acxtargets.h header