IAudioSessionControl::GetDisplayName 方法 (audiopolicy.h)
GetDisplayName 方法检索音频会话的显示名称。
语法
HRESULT GetDisplayName(
[out] LPWSTR *pRetVal
);
参数
[out] pRetVal
指向指针变量的指针,方法将包含显示名称的以 null 结尾的宽字符字符串的地址写入其中。 方法为字符串分配存储。 调用方负责通过调用 CoTaskMemFree 函数,在不再需要存储时释放存储。 有关 CoTaskMemFree 的信息,请参阅 Windows SDK 文档。
返回值
如果该方法成功,则它会返回 S_OK。 如果失败,可能的返回代码包括但不限于下表中显示的值。
返回代码 | 说明 |
---|---|
|
参数 pRetVal 为 NULL。 |
|
内存不足。 |
|
音频终结点设备已拔出,或者音频硬件或关联的硬件资源已重新配置、禁用、删除或以其他方式不可用。 |
|
Windows 音频服务未运行。 |
注解
如果客户端尚未调用 IAudioSessionControl::SetDisplayName 来设置显示名称,则字符串将为空。 Sndvol 程序使用自动生成的默认名称来标记音频会话的音量控件,而不是显示空名称字符串。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | Windows Vista [桌面应用 | UWP 应用] |
最低受支持的服务器 | Windows Server 2008 [桌面应用 | UWP 应用] |
目标平台 | Windows |
标头 | audiopolicy.h |