Skip to content

Latest commit

 

History

History
118 lines (90 loc) · 3.02 KB

nc-acxcircuit-evt_acx_circuit_composite_circuit_initialize.md

File metadata and controls

118 lines (90 loc) · 3.02 KB
Raw
UID tech.root title ms.date targetos description prerelease req.assembly req.construct-type req.ddi-compliance req.dll req.header req.idl req.include-header req.irql req.kmdf-ver req.lib req.max-support req.namespace req.redist req.target-min-winverclnt req.target-min-winversvr req.target-type req.type-library req.umdf-ver req.unicode-ansi topic_type api_type api_location api_name f1_keywords dev_langs
NC:acxcircuit.EVT_ACX_CIRCUIT_COMPOSITE_CIRCUIT_INITIALIZE
audio
EVT_ACX_CIRCUIT_COMPOSITE_CIRCUIT_INITIALIZE
12/14/2022
Windows
The EVT_ACX_CIRCUIT_COMPOSITE_CIRCUIT_INITIALIZE callback is used by the driver to do any initialization of a composite circuit when it is detected and initialized by ACX Manager.
false
function
acxcircuit.h
PASSIVE_LEVEL
apiref
LibDef
acxcircuit.h
EVT_ACX_CIRCUIT_COMPOSITE_CIRCUIT_INITIALIZE
EVT_ACX_CIRCUIT_COMPOSITE_CIRCUIT_INITIALIZE
acxcircuit/EVT_ACX_CIRCUIT_COMPOSITE_CIRCUIT_INITIALIZE
c++

-description

The EVT_ACX_CIRCUIT_COMPOSITE_CIRCUIT_INITIALIZE callback is used by the driver to do any initialization of a composite circuit when it is detected and initialized by ACX Manager.

-parameters

-param Device

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

-param Circuit

The ACXCIRCUIT object being initialized. For more information about ACX objects, see Summary of ACX Objects.

-param CircuitProperties

Optional handle to CircuitProperties. This is an optional ACXOBJECTBAG object for ACXCIRCUIT's properties.

-returns

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

-remarks

Example

This sample code shows how the driver retrieves a circuit property from the specified circuit property object bag.

DspR_EvtCircuitCompositeCircuitInitialize(
    _In_     WDFDEVICE      Device,
    _In_     ACXCIRCUIT     Circuit,
    _In_opt_ ACXOBJECTBAG   CircuitProperties
    )
{
    NTSTATUS status = STATUS_SUCCESS;

    PAGED_CODE();
    
    UNREFERENCED_PARAMETER(Device);
    UNREFERENCED_PARAMETER(Circuit);

    if (CircuitProperties != NULL)
    {
        DECLARE_CONST_ACXOBJECTBAG_DRIVER_PROPERTY_NAME(msft, TestUI4);
        ULONG testUI4;

        status = AcxObjectBagRetrieveUI4(CircuitProperties, &TestUI4, &testUI4);
        if (!NT_SUCCESS(status))
        {
            // Log error.
            goto exit;
        }

        //...
    }
    
    //...

    // All done.
    status = STATUS_SUCCESS;

exit:
    return status;
}

ACX requirements

Minimum ACX version: 1.0

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

-see-also