IEnumPortableDeviceObjectIDs

IEnumPortableDeviceObjectIDs インターフェイスは、ポータブルデバイス上のオブジェクトを列挙します。このインターフェイスは、最初にデバイスに対して IPortableDeviceContent::EnumObjects を呼び出すことで取得します。

Next メソッドは、列挙シーケンス内の次の 1 つ以上のオブジェクト ID を取得します。

このメソッドは HRESULT を返します。取り得る値には、次の表に示すものが含まれます (ただしこれらに限定されません)。

シーケンス内に残っている要素数が要求された数より少ない場合、このメソッドは残りの要素を取得します。実際に取得された要素数は pcFetched を通じて返されます (呼び出し元がこのパラメーターに NULL を渡した場合を除きます)。列挙されるオブジェクトはすべて同階層のもの (ピア) です。つまり、あるオブジェクトの子を列挙すると、直接の子だけが列挙され、孫やそれより深い階層のオブジェクトは列挙されません。

使用例

// この数値は、IEnumPortableDeviceObjectIDs::Next() の各呼び出しで
// 要求するオブジェクト識別子の個数を制御します
#define NUM_OBJECTS_TO_REQUEST  10

// 指定されたオブジェクト識別子を親として列挙を行う、再帰的に呼び出される関数。
void RecursiveEnumerate(LPCWSTR wszParentObjectID, IPortableDeviceContent* pContent)
{
    HRESULT                       hr             = S_OK;
    IEnumPortableDeviceObjectIDs* pEnumObjectIDs = NULL;

    if ((wszParentObjectID == NULL) ||
        (pContent          == NULL))
    {
        return;
    }

    // wszParentObjectID は、列挙に使用する親のオブジェクト識別子です

    // 指定した親オブジェクト識別子を指定して EnumObjects を呼び出し、
    // IEnumPortableDeviceObjectIDs インターフェイスを取得します。
    hr = pContent->EnumObjects(0, wszParentObjectID, NULL, &pEnumObjectIDs);
    if (FAILED(hr))
    {
        // IPortableDeviceContent から IEnumPortableDeviceObjectIDs を取得できませんでした
    }

    // S_OK が返されている間、Next() を呼び出し続けます。
    while(hr == S_OK)
    {
        DWORD  cFetched = 0;
        LPWSTR szObjectIDArray[NUM_OBJECTS_TO_REQUEST] = {0};
        hr = pEnumObjectIDs->Next(NUM_OBJECTS_TO_REQUEST, // NEXT の各呼び出しで要求するオブジェクト数
                                  szObjectIDArray,        // NEXT の各呼び出しで値が設定される LPWSTR 配列
                                  &cFetched);             // LPWSTR 配列に書き込まれたオブジェクト数
        if (SUCCEEDED(hr))
        {
            // Next() の結果をたどって再帰的に列挙します
            // 返されたオブジェクト識別子はすべて CoTaskMemFree() で解放することを忘れないでください
            for (DWORD dwIndex = 0; dwIndex < cFetched; dwIndex++)
            {
                RecursiveEnumerate(szObjectIDArray[dwIndex],pContent);

                // 再帰的な列挙呼び出しが完了した後で、割り当てられた LPWSTR を解放します。
                CoTaskMemFree(szObjectIDArray[dwIndex]);
                szObjectIDArray[dwIndex] = NULL;
            }
        }
    }

    // 処理が終わったら IEnumPortableDeviceObjectIDs を解放します
    if (pEnumObjectIDs != NULL)
    {
        pEnumObjectIDs->Release();
        pEnumObjectIDs = NULL;
    }
}

Skip メソッドは、列挙シーケンス内の指定した数のオブジェクトをスキップします。

このメソッドは HRESULT を返します。取り得る値には、次の表に示すものが含まれます (ただしこれらに限定されません)。

Reset メソッドは、列挙シーケンスを先頭にリセットします。(IEnumPortableDeviceObjectIDs.Reset)

このメソッドは HRESULT を返します。取り得る値には、次の表に示すものが含まれます (ただしこれらに限定されません)。

このメソッドを呼び出した後に、同じオブジェクトが列挙される保証はありません。これは、以前に列挙されたオブジェクトが削除されていたり、新しいオブジェクトが追加されていたりする可能性があるためです。

Clone メソッドは、現在の IEnumPortableDeviceObjectIDs インターフェイスを複製します。

このメソッドは HRESULT を返します。取り得る値には、次の表に示すものが含まれます (ただしこれらに限定されません)。

Cancel メソッドは、保留中の操作をキャンセルします。(IEnumPortableDeviceObjectIDs.Cancel)

このメソッドは HRESULT を返します。取り得る値には、次の表に示すものが含まれます (ただしこれらに限定されません)。

このメソッドは、現在のデバイスハンドル (IPortableDevice インターフェイスに関連付けられたセッションに対応します) 上の保留中の操作をすべてキャンセルします。Windows Portable Devices (WPD) API は、特定の操作のみを対象としたキャンセルをサポートしていません。