ホーム › Media.DeviceManager › IMDSPEnumDevice

IMDSPEnumDevice

COM

📘 Microsoft Learn (日本語) · English

IID1dcb3a11-33ed-11d3-8470-00c04f79dbc0継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IMDSPEnumDevice インターフェイスは、メディアデバイスを列挙するために使用します。

メソッド 4

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

vtbl 3 HRESULT Next(DWORD celt, IMDSPDevice** ppDevice, DWORD* pceltFetched)

Next メソッドは、次の celt 個の IMDSPDevice インターフェイスへのポインターを取得します。

celt	DWORD	in	要求するデバイスの数。
ppDevice	IMDSPDevice**	out	呼び出し元が確保した、celt 個の IMDSPDevice ポインターの配列。これ以上デバイスが存在しない場合、またはエラーが発生した場合は NULL を返します。celt が 1 より大きい場合、呼び出し元は celt 個のインターフェイスポインターを格納できるだけのメモリを確保する必要があります。
pceltFetched	DWORD*	out	取得されたインターフェイスの数を受け取る ULONG 型変数へのポインター。

戻り値

このメソッドは HRESULT を返します。Windows Media Device Manager のすべてのインターフェイスメソッドは、次のいずれかの種類のエラーコードを返す可能性があります。

標準の COM エラーコード
HRESULT 値に変換された Windows エラーコード
Windows Media Device Manager のエラーコード

発生し得るエラーコードの詳細な一覧については、Error Codes を参照してください。

解説(Remarks)

列挙対象のデバイスに対応するサービスプロバイダーインターフェイスがこれ以上ない場合、または celt パラメーターで要求された数よりもインターフェイスの数が少ない場合、Next の戻り値は S_FALSE になります。この場合は、pceltFetched パラメーターを確認して、インターフェイスが返されたかどうか、また返された場合はその数を判断する必要があります。

デバイス列挙子には、デバイスの挿入や取り外しの結果が反映されないことがあります。

このメソッドは実装する必要があります。WMDM_E_NOTSUPPORTED または E_NOTIMPL を返してはなりません。詳細については、Mandatory and Optional Interfaces を参照してください。

vtbl 4 HRESULT Skip(DWORD celt, DWORD* pceltFetched)

Skip メソッドは、列挙シーケンス内で指定した数のメディアデバイスインターフェイスをスキップします。

celt	DWORD	in	スキップする要素の数。
pceltFetched	DWORD*	out	実際にスキップされた要素の数へのポインター。

戻り値

標準の COM エラーコード
HRESULT 値に変換された Windows エラーコード
Windows Media Device Manager のエラーコード

発生し得るエラーコードの詳細な一覧については、Error Codes を参照してください。

解説(Remarks)

celt パラメーターで指定した数が、列挙シーケンスに残っているインターフェイスの実際の数より多い場合、Skip の戻り値は S_FALSE になります。この場合は、pceltFetched パラメーターを確認して、実際にスキップされたインターフェイスの数を判断する必要があります。列挙されたメディアデバイスインターフェイスの配列の末尾までスキップした場合、その後の Next の呼び出しは S_FALSE を返します。

vtbl 5 HRESULT Reset()

Reset メソッドは、列挙シーケンスを先頭にリセットします。その後 Next を呼び出すと、列挙シーケンス内の最初の Windows Media Device Manager インターフェイスが取得されます。

戻り値

標準の COM エラーコード
HRESULT 値に変換された Windows エラーコード
Windows Media Device Manager のエラーコード

発生し得るエラーコードの詳細な一覧については、Error Codes を参照してください。

解説(Remarks)

vtbl 6 HRESULT Clone(IMDSPEnumDevice** ppEnumDevice)

Clone メソッドは、現在の列挙子と同じ列挙状態を持つ別の列挙子を作成します。(IMDSPEnumDevice.Clone)

ppEnumDevice

IMDSPEnumDevice**

out

IMDSPEnumDevice インターフェイスへのポインター。

戻り値

標準の COM エラーコード
HRESULT 値に変換された Windows エラーコード
Windows Media Device Manager のエラーコード

発生し得るエラーコードの詳細な一覧については、Error Codes を参照してください。

解説(Remarks)

この関数を使用すると、クライアントは列挙シーケンス内の特定の位置を記録しておき、後でその位置に戻ることができます。新しい列挙子は、元の列挙子と同じインターフェイスをサポートします。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IMDSPEnumDevice "{1DCB3A11-33ED-11D3-8470-00C04F79DBC0}"
#usecom global IMDSPEnumDevice IID_IMDSPEnumDevice "{}"
#comfunc global IMDSPEnumDevice_Next   3 int,sptr,var
#comfunc global IMDSPEnumDevice_Skip   4 int,var
#comfunc global IMDSPEnumDevice_Reset  5
#comfunc global IMDSPEnumDevice_Clone  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IMDSPEnumDevice "{1DCB3A11-33ED-11D3-8470-00C04F79DBC0}"
#usecom global IMDSPEnumDevice IID_IMDSPEnumDevice "{}"
#comfunc global IMDSPEnumDevice_Next   3 int,sptr,sptr
#comfunc global IMDSPEnumDevice_Skip   4 int,sptr
#comfunc global IMDSPEnumDevice_Reset  5
#comfunc global IMDSPEnumDevice_Clone  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。