IControlInterface：：GetName 方法 (devicetopology.h)

  • 项目

GetName 方法获取控件接口封装的音频函数的友好名称。

语法

HRESULT GetName(
  [out] LPWSTR *ppwstrName
);

参数

[out] ppwstrName

指向字符串指针的指针，方法在其中写入包含友好名称的以 null 结尾的宽字符字符串的地址。 方法为字符串分配存储。 当不再需要存储时，调用方负责通过调用 CoTaskMemFree 函数来释放存储。 如果 GetName 调用失败， *ppwstrName 为 NULL。 有关 CoTaskMemFree 的信息，请参阅 Windows SDK 文档。

返回值

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

返回代码 说明
E_POINTER
 指针 ppwstrName 为 NULL。
E_OUTOFMEMORY
 内存不足。

备注

作为友好名称的示例，具有 IAudioPeakMeter 接口的子单元可能具有友好名称“peak meter”。

要求

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

另请参阅

IAudioPeakMeter 接口

IControlInterface 接口