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 |