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 インターフェイス