IAudioSystemEffectsCustomFormats：：GetFormatRepresentation 方法 (audioenginebaseapo.h)

方法 GetFormatRepresentation 检索自定义格式的字符串表示形式，以便它可以显示在用户界面上。

语法

HRESULT GetFormatRepresentation(
  [in]            UINT   nFormat,
  [out, optional] LPWSTR *ppwstrFormatRep
);

参数

[in] nFormat

指定受支持格式的索引。 此参数可以是介于 0 到 GetFormatCount 返回值 1 之间的任何值。 换句话说，从零到 GetFormatCount 范围内的任何值 ( ) - 1。

[out, optional] ppwstrFormatRep

指定接收描述自定义格式的以 NULL 结尾的 Unicode 字符串的缓冲区的地址。

返回值

调用成功时，该方法 GetFormatRepresentation 返回S_OK。 否则，它将返回下表中显示的错误代码之一。

返回代码	说明
E_POINTER	传递给函数的指针无效
E_OUTOFMEMORY	无法分配返回缓冲区
E_INVALIDARG	nFormat 已超过范围

注解

sAPO 使用 CoTaskMemAlloc 分配返回的字符串。 调用方必须使用 CoTaskMemFree 删除 ppwstrFormatRep 参数指向的缓冲区。

要求

要求	值
最低受支持的客户端	在 Windows Vista 和更高版本的 Windows 中可用。
目标平台	桌面
标头	audioenginebaseapo.h (包括 Audioenginebaseapo.h)
IRQL	所有级别。

另请参阅

CoTaskMemAlloc

CoTaskMemFree

GetFormatCount