Edit

AcxCircuitInitAssignName function (acxcircuit.h)

  • Article

The AcxCircuitInitAssignName function assigns a friendly name for the ACXCIRCUIT.

Syntax

NTSTATUS AcxCircuitInitAssignName(
  PACXCIRCUIT_INIT CircuitInit,
  PCUNICODE_STRING CircuitName
);

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.

CircuitName

A unicode string with the circuit name, such as Microphone0.

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

The CircuitName string must match the INF string that identifies the audio interface.

Example

Example usage is shown below.

    // Circuit Name
    DECLARE_CONST_UNICODE_STRING(circuitName, L"Microphone0");

    //
    // Add circuit identifiers.
    //
    AcxCircuitInitSetComponentId(CircuitInit, &COMPONENT_GUID);

    AcxCircuitInitAssignName(CircuitInit, &circuitName);

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

See also