KSPROPERTY_SYSAUDIO_DEVICE_INTERFACE_NAME

The KSPROPERTY_SYSAUDIO_DEVICE_INTERFACE_NAME property retrieves a Unicode string containing the Plug and Play device interface name for the specified virtual audio device.

Usage Summary Table

GetSetTargetProperty descriptor typeProperty value type

Yes

No

Filter

KSPROPERTY+ULONG

LPWSTR

 

The property descriptor (instance data) consists of a KSPROPERTY structure followed by a ULONG variable containing a device ID that identifies a virtual audio device. If SysAudio enumerates n virtual audio devices (see KSPROPERTY_SYSAUDIO_DEVICE_COUNT), then valid device IDs range from 0 to n-1. Also, a device ID value of -1 can be used to indicate the current device, which is the last virtual audio device opened by a KSPROPERTY_SYSAUDIO_DEVICE_INSTANCE or KSPROPERTY_SYSAUDIO_INSTANCE_INFOset-property request.

The property value (operation data) is a pointer to a null-terminated string of Unicode characters that contains the device's interface name.

Return Value

A KSPROPERTY_SYSAUDIO_DEVICE_INTERFACE_NAME property request returns STATUS_SUCCESS to indicate that it has completed successfully. Otherwise, the request returns an appropriate error status code.

Requirements

Header

Ksmedia.h (include Ksmedia.h)

See also

KSPROPERTY
KSPROPERTY_SYSAUDIO_DEVICE_COUNT
KSPROPERTY_SYSAUDIO_DEVICE_INSTANCE
KSPROPERTY_SYSAUDIO_INSTANCE_INFO

 

 

Send comments about this topic to Microsoft

Show: