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

IWMDMEnumDevice

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

公式ドキュメント

IWMDMEnumDevice インターフェースは、コンピューターに接続されているポータブルデバイスを列挙します。このインターフェースを取得するには、IWMDeviceManager::EnumDevices を呼び出します。

メソッド 4

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

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

Next メソッドは、IWMDMDevice インターフェースで表される次のデバイスへのポインターを返します。

celtDWORDin要求するデバイスの数。
ppDeviceIWMDMDevice**out呼び出し元が割り当てた IWMDMDevice インターフェースポインターの配列へのポインター。この配列のサイズは IWMDMDevice *[celt] である必要があります。呼び出し元は、使用を終えたらこれらのインターフェースを解放する必要があります。配列全体を割り当てたくない場合は、「解説」に示すように、IWMDMDevice インターフェースへのポインターのアドレスを渡すだけで済みます。
pceltFetchedDWORD*out返されたデバイス (インターフェース) の数を受け取る変数へのポインター。

戻り値

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

返される可能性のあるエラーコードの詳細な一覧については、Error Codes を参照してください。

解説(Remarks)

返されるデバイスインターフェースは、キャッシュされたデバイスの一覧に基づいています。プラグアンドプレイデバイスが接続または取り外されても、現在の列挙子にはそれが反映されないため、Next はキャッシュされた一覧に基づいてデバイスを返します。アプリケーションは、IWMDeviceManager::EnumDevices を呼び出して新しい列挙子オブジェクトを取得し、更新されたデバイスの一覧を得る必要があります。

一度に 1 つのインターフェースだけを取得したい場合は、次のコードに示すように、このメソッドのために配列を割り当てる必要はありません。


// 各デバイスを調べるためにデバイス列挙子を取得します。
CComPtr<IWMDeviceManager2> pIWMDevMgr2;
hr = m_IWMDeviceMgr->QueryInterface (__uuidof(IWMDeviceManager2), (void**) &pIWMDevMgr2);
if (hr == S_OK)
{
    // TODO: アプリケーションが IWMDeviceManager2 を取得したことを示すメッセージを表示します。
}
else
{
    // TODO: アプリケーションが EnumDevices で IWMDeviceManager2 を 
    // 取得できなかったことを示すメッセージを表示します。
    return hr;
}

// より高速なプラグアンドプレイ対応の EnumDevices2 メソッドを使用してデバイスを列挙します。
CComPtr<IWMDMEnumDevice> pEnumDevice;
hr = pIWMDevMgr2->EnumDevices2(&pEnumDevice);
if (hr != S_OK)
{
    //.TODO: EnumDevices2 の呼び出しでエラーが発生したことを示すメッセージを表示します。
    return hr;
}

// デバイスを列挙します。
IWMDMDevice *pIWMDMDevice;
ULONG ulFetched = 0;
while(pEnumDevice->Next(1, &pIWMDMDevice, &ulFetched) == S_OK)
{
    if (ulFetched != 1)
    {
        return E_FAIL;
    }
    // ここで何らかの処理を行います....
}
vtbl 4 HRESULT Skip(DWORD celt, DWORD* pceltFetched)

Skip メソッドは、列挙シーケンス内の指定された数のデバイスをスキップします。

celtDWORDinスキップするデバイスの数。
pceltFetchedDWORD*out実際にスキップされたデバイスの数。

戻り値

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

返される可能性のあるエラーコードの詳細な一覧については、Error Codes を参照してください。

解説(Remarks)

スキップを要求したデバイスの数が残りのデバイス数より多い場合、Skip の戻り値は S_FALSE になります。この場合、スキップされたインターフェースの数を判断するには pceltFetched を使用する必要があります。デバイス配列の末尾までスキップした場合、その後の Next の呼び出しも S_FALSE を返します。標準の列挙子の Skip メソッドの詳細については、Microsoft の Web サイトで入手できる Microsoft COM のドキュメントを参照してください。

vtbl 5 HRESULT Reset()

Reset メソッドは列挙をリセットし、Next が最初のデバイスへのポインターを返すようにします。

戻り値

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

返される可能性のあるエラーコードの詳細な一覧については、Error Codes を参照してください。
vtbl 6 HRESULT Clone(IWMDMEnumDevice** ppEnumDevice)

Clone メソッドは、IWMDMEnumDevice インターフェースのコピーを返します。新しい列挙子は、現在の列挙子と同じ列挙状態を指定します。

ppEnumDeviceIWMDMEnumDevice**outIWMDMEnumDevice インターフェースへのポインターのアドレス。呼び出し元は、使用を終えたらこのインターフェースを解放する必要があります。

戻り値

このメソッドは HRESULT を返します。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_IWMDMEnumDevice "{1DCB3A01-33ED-11D3-8470-00C04F79DBC0}"
#usecom global IWMDMEnumDevice IID_IWMDMEnumDevice "{}"
#comfunc global IWMDMEnumDevice_Next   3 int,sptr,var
#comfunc global IWMDMEnumDevice_Skip   4 int,var
#comfunc global IWMDMEnumDevice_Reset  5
#comfunc global IWMDMEnumDevice_Clone  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。