IDeviceTopology::GetDeviceId メソッド (devicetopology.h)

  • [アーティクル]

GetDeviceId メソッドは、device-topology オブジェクトによって表されるデバイスのデバイス識別子を取得します。

構文

HRESULT GetDeviceId(
  [out] LPWSTR *ppwstrDeviceId
);

パラメーター

[out] ppwstrDeviceId

デバイス識別子を含む null で終わるワイド文字列のアドレスをメソッドが書き込むポインター変数へのポインター。 メソッドは、文字列のストレージを割り当てます。 呼び出し元は、不要になったときに CoTaskMemFree 関数を呼び出すことによって、ストレージを解放する役割を担います。 GetDeviceId 呼び出しが失敗した場合、*ppwstrDeviceId は NULL です。 CoTaskMemFree の詳細については、Windows SDK のドキュメントを参照してください。

戻り値

メソッドが成功した場合は、S_OK を返します。 失敗した場合、次の表に示す値が含まれますが、これに限定されません。

リターン コード 説明
D_POINTER
 ポインター ppwstrDeviceId は NULL です。
E_OUTOFMEMORY
 メモリが不足しています。

注釈

このメソッドから取得したデバイス識別子は、 IMMDeviceEnumerator::GetDevice メソッドへの入力パラメーターとして使用できます。

GetDeviceId メソッドを使用するコード例については、「IKsControl インターフェイスを使用してオーディオ プロパティにアクセスする」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー devicetopology.h

こちらもご覧ください

IDeviceTopology インターフェイス

IMMDeviceEnumerator::GetDevice