IAudioSystemEffectsCustomFormats::GetFormatRepresentation メソッド (audioenginebaseapo.h)
メソッドは GetFormatRepresentation 、ユーザー インターフェイスに表示できるように、カスタム形式の文字列表現を取得します。
構文
HRESULT GetFormatRepresentation(
[in] UINT nFormat,
[out, optional] LPWSTR *ppwstrFormatRep
);
パラメーター
[in] nFormat
サポートされている形式のインデックスを指定します。 このパラメーターには、 GetFormatCount の戻り値より 0 から 1 未満の範囲の任意の値を指定できます。 つまり、0 から GetFormatCount( ) - 1 までの範囲の任意の値です。
[out, optional] ppwstrFormatRep
カスタム形式を記述する NULL で終わる Unicode 文字列を受け取るバッファーのアドレスを指定します。
戻り値
メソッドは GetFormatRepresentation 、呼び出しが成功したときにS_OKを返します。 それ以外の場合は、次の表に示すエラー コードのいずれかを返します。
| リターン コード | 説明 |
|---|---|
|
無効なポインターが関数に渡されました |
|
戻りバッファーを割り当てることができません |
|
nFormat が範囲外です |
注釈
sAPO は CoTaskMemAlloc を使用して、返される文字列を割り当てます。 呼び出し元は CoTaskMemFree を使用して、 ppwstrFormatRep パラメーターが指すバッファーを削除する必要があります。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista 以降のバージョンの Windows で使用できます。 |
| 対象プラットフォーム | デスクトップ |
| Header | audioenginebaseapo.h (Audioenginebaseapo.h を含む) |
| IRQL | すべてのレベル。 |