AcxCircuitInitAssignProperties function (acxcircuit.h)

Article
02/22/2024

The AcxCircuitInitAssignProperties function assigns one or more ACX properties for the ACXCIRCUIT.

Syntax

NTSTATUS AcxCircuitInitAssignProperties(
  PACXCIRCUIT_INIT   CircuitInit,
  PACX_PROPERTY_ITEM Properties,
  ULONG              PropertiesCount
);

Parameters

CircuitInit

The ACXCIRCUIT_INIT structure that defines the circuit initialization. ACXCIRCUIT_INIT is an opaque object used for circuit initialization. Use AcxCircuitInitAllocate to initialize the ACXCIRCUIT_INIT structure.

Properties

An ACX_PROPERTY_ITEM structure that defines a set of properties that will be used for circuit initialization by the circuit factory.

PropertiesCount

The number of properties that will be added to the circuit. This is a one based count.

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

Drivers should only add driver owned properties.

Example

Example usage is shown below.


    PACXCIRCUIT_INIT circuitInit = NULL;
    circuitInit = AcxCircuitInitAllocate(Device);

    ACX_PROPERTY_ITEM CircuitProperties[] =
    {
        {
            &KSPROPSETID_AudioPosture,
            KSPROPERTY_AUDIOPOSTURE_ORIENTATION,
            KSPROPERTY_TYPE_SET,
            EvtCircuitPropertyHandler,
            nullptr,                            //Reserved
            0,                                  //ControlCb
            sizeof(AUDIOPOSTURE_ORIENTATION),   //ValueCb
        },
    };


    status = AcxCircuitInitAssignProperties(circuitInit,
        CircuitProperties,
        SIZEOF_ARRAY(CircuitProperties));

ACX requirements

Minimum ACX version: 1.0

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

Requirements

Requirement	Value
Header	acxcircuit.h
IRQL	PASSIVE_LEVEL

Share via