AcxDeviceDetachCircuit - NtDoc

Native API online documentation, based on the System Informer (formerly Process Hacker) phnt headers
// acxdevice.h

NTSTATUS AcxDeviceDetachCircuit(
  WDFDEVICE  Device,
  ACXCIRCUIT Circuit
);
View the official Windows Driver Kit DDI reference

NtDoc

No description available.

Windows Driver Kit DDI reference (nf-acxdevice-acxdevicedetachcircuit)

Description

The AcxDeviceDetachCircuit function detaches an audio circuit from a WDFDEVICE prior to removal.

Parameters

Device

The WDFDEVICE from which to detach the audio circuit specified by the Circuit parameter.

Circuit

The audio circuit to remove from the WDFDEVICE specified by the Device parameter.

Return value

AcxDeviceDetachCircuit returns STATUS_SUCCESS if the call was successful. Otherwise, it returns an NTSTATUS error code.

This function can only be called from the EVT_WDF_DEVICE_RELEASE_HARDWARE callback function for this device.

AcxDeviceDetachCircuit detaches the circuit from the device. The caller is responsible for deleting the ACXCIRCUIT object.

Remarks

Example

WDFDEVICE                    Device;
NTSTATUS                     status;
PCODEC_RENDER_DEVICE_CONTEXT renderDevCtx = NULL;

// Code to initialize WDFDEVICE...

renderDevCtx = GetRenderDeviceContext(Device);

ASSERT(renderDevCtx->Circuit);
status = AcxDeviceDetachCircuit(Device, renderDevCtx->Circuit);

if (!NT_SUCCESS(status))
{
    ASSERT(FALSE);
    goto exit;
}

ACX requirements

Minimum ACX version: 1.0

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

See also