IMMDevice::GetId 方法 (mmdeviceapi.h)

GetId 方法检索标识音频终结点设备的终结点 ID 字符串

语法

HRESULT GetId(
  [out] LPWSTR *ppstrId
);

parameters

[out] ppstrId

指向指针变量的指针,方法将包含终结点设备 ID 的以 null 结尾的宽字符字符串的地址写入其中。 方法为字符串分配存储。 调用方负责通过调用 CoTaskMemFree 函数,在不再需要存储时释放存储。 如果 GetId 调用失败, 则 *ppstrId 为 NULL。 有关 CoTaskMemFree 的信息,请参阅 Windows SDK 文档。

返回值

如果该方法成功,则它会返回 S_OK。 如果失败,可能的返回代码包括但不限于下表中显示的值。

返回代码 说明
E_OUTOFMEMORY
内存不足。
E_POINTER
参数 pwstrIdNULL

注解

从此方法获取的终结点 ID 字符串标识由 IMMDevice 接口实例表示的音频终结点设备。 客户端可以使用终结点 ID 字符串在以后或通过调用 IMMDeviceEnumerator::GetDevice 方法在不同的进程中创建音频终结点设备的实例。 客户端应将终结点 ID 字符串的内容视为不透明。 也就是说,客户端 不应 尝试分析字符串的内容以获取有关设备的信息。 原因是字符串格式未定义,可能会从 MMDevice API 系统模块的一个实现更改为下一个实现。

有关调用 GetId 方法的代码示例,请参阅以下主题:

要求

   
最低受支持的客户端 Windows Vista [仅限桌面应用]
最低受支持的服务器 Windows Server 2008 [仅限桌面应用]
目标平台 Windows
标头 mmdeviceapi.h

另请参阅

IMMDevice 接口

IMMDeviceEnumerator::GetDevice