Win32 API 日本語リファレンス
ホームMedia.Audio › IMMDeviceCollection

IMMDeviceCollection

COM
IID0bd7a1be-7a1a-44db-8397-cc5392387b5e継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IMMDeviceCollection インターフェイスは、マルチメディアデバイスリソースのコレクションを表します。

メソッド 2

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT GetCount(DWORD* pcDevices)

GetCount メソッドは、デバイスコレクション内のデバイス数を取得します。

pcDevicesDWORD*outデバイスコレクション内のデバイス数を書き込む UINT 変数へのポインター。

戻り値

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

戻り値 説明
E_POINTER
パラメーター pcDevicesNULL です。

解説(Remarks)

GetCount メソッドを呼び出すコード例については、Device Properties を参照してください。

vtbl 4 HRESULT Item(DWORD nDevice, IMMDevice** ppDevice)

Item メソッドは、デバイスコレクション内の指定した項目へのポインターを取得します。

nDeviceDWORDinデバイス番号。コレクションに n 個のデバイスが含まれる場合、デバイスには 0 から n– 1 までの番号が付けられます。
ppDeviceIMMDevice**outデバイスコレクション内の指定した項目の IMMDevice インターフェイスのアドレスを書き込むポインター変数へのポインター。このメソッドを通じて、呼び出し元はインターフェイスへのカウント付き参照を取得します。呼び出し元は、インターフェイスが不要になったときに、そのインターフェイスの Release メソッドを呼び出して解放する責任があります。Item の呼び出しが失敗した場合、*ppDeviceNULL になります。

戻り値

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

戻り値 説明
E_POINTER
パラメーター ppDeviceNULL です。
E_INVALIDARG
パラメーター nDevice が有効なデバイス番号ではありません。

解説(Remarks)

このメソッドは、デバイスコレクション内の指定した項目の IMMDevice インターフェイスへのポインターを取得します。コレクション内の各項目は、オーディオエンドポイントデバイスを表すエンドポイントオブジェクトです。呼び出し元は、デバイス番号を指定してデバイスコレクションからデバイスを選択します。n 個のデバイスから成るコレクションでは、有効なデバイス番号の範囲は 0 から n– 1 までです。コレクション内のデバイス数を取得するには、IMMDeviceCollection::GetCount メソッドを呼び出します。

Item メソッドを呼び出すコード例については、Device Properties を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"

出力引数:
#define global IID_IMMDeviceCollection "{0BD7A1BE-7A1A-44DB-8397-CC5392387B5E}"
#usecom global IMMDeviceCollection IID_IMMDeviceCollection "{}"
#comfunc global IMMDeviceCollection_GetCount  3 var
#comfunc global IMMDeviceCollection_Item      4 int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。