Skip to content

Latest commit

 

History

History
91 lines (69 loc) · 2.32 KB

nf-acxcircuit-acxcircuitinitassigncomponenturi.md

File metadata and controls

91 lines (69 loc) · 2.32 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
NF:acxcircuit.AcxCircuitInitAssignComponentUri
audio
AcxCircuitInitAssignComponentUri
12/14/2022
Windows
The AcxCircuitInitAssignComponentUri function assigns an URI string as identifier for the ACXCIRCUIT.
false
function
acxcircuit.h
PASSIVE_LEVEL
apiref
HeaderDef
acxcircuit.h
AcxCircuitInitAssignComponentUri
AcxCircuitInitAssignComponentUri
acxcircuit/AcxCircuitInitAssignComponentUri
c++

-description

The AcxCircuitInitAssignComponentUri function assigns an URI string as ID for the ACXCIRCUIT.

-parameters

-param 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.

-param ComponentUri

A unicode string describing the URI that uniquely identifies the ACXCIRCUIT.

-returns

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

-remarks

The driver must initialize the circuit's identity by setting its URI and/or its ID (AcxCircuitInitSetComponentId).

Example

Example usage is shown below.

    DECLARE_CONST_UNICODE_STRING(CODEC_CIRCUIT_CAPTURE_URI, L"acx:test:acxcodectestdriver:codec0:circuit0:microphone0");

    // Get a CircuitInit structure.
    //
    circuitInit = AcxCircuitInitAllocate(Device);

    //
    // Add circuit identifiers.
    //
    status = AcxCircuitInitAssignComponentUri(circuitInit, &CODEC_CIRCUIT_CAPTURE_URI);

ACX requirements

Minimum ACX version: 1.0

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

-see-also