IOfflineFilesItemContainer

オフラインファイルキャッシュ内の項目列挙機能にアクセスするために使用します。

このメソッドを実装するキャッシュ項目の子項目の列挙子を返します。(IOfflineFilesItemContainer.EnumItems)

成功した場合は S_OK を、それ以外の場合はエラー値を返します。

キャッシュ全体をトップダウンで列挙するには、次の手順を実行します。

1. CLSID_OfflineFilesCache のインスタンスを作成し、その IOfflineFilesItemContainer インターフェイスを取得します。
2. EnumItems メソッドを呼び出して、サーバーエントリの列挙子を取得します。
3. 返された各エントリに対して、IOfflineFilesItemContainer を要求する QueryInterface を呼び出します。
4. QueryInterface が成功した場合、その項目は子をサポートしています。その場合は各子を列挙し、それぞれに対して IOfflineFilesItemContainer を要求する QueryInterface を呼び出します。このパターンを再帰的に適用することで、キャッシュ全体を列挙できます。

例

この例では、単純な再帰的実装を用いてオフラインファイルキャッシュをトップダウンで走査する方法を示します。

HRESULT EnumItems(IOfflineFilesItemContainer *pContainer);

//
// Emits the item's path string to the console.
//
HRESULT ReportItem(
    IOfflineFilesItem *pItem
    )
{
    LPWSTR pszPath;
    HRESULT hr = pItem->GetPath(&pszPath);
    if (SUCCEEDED(hr))
    {
        LPCWSTR pszType = L"";
        OFFLINEFILES_ITEM_TYPE ItemType;
        hr = pItem->GetItemType(&ItemType);
        if (SUCCEEDED(hr))
        {
            switch(ItemType)
            {
                case OFFLINEFILES_ITEM_TYPE_SERVER:
                    pszType = L" [SERVER]";
                    break;

                case OFFLINEFILES_ITEM_TYPE_SHARE:
                    pszType = L" [SHARE]";
                    break;

                case OFFLINEFILES_ITEM_TYPE_DIRECTORY:
                    pszType = L" [DIR]";
                    break;

                default:
                    break;
            }
            wprintf(L"%s%s", pszPath, pszType);
        }
        CoTaskMemFree(pszPath);
    }
    return hr;
}

//
// Processes the "current" item then recursively enumerate children
// if the item is a container (server, share, directory).
//
HRESULT ProcessItem(
    IOfflineFilesItem *pItem
    )
{
    HRESULT hr = ReportItem(pItem);
    if (SUCCEEDED(hr))
    {
        IOfflineFilesItemContainer *pContainer;
        hr = pItem->QueryInterface(IID_IOfflineFilesItemContainer,
                                   (void **)&pContainer);
        if (SUCCEEDED(hr))
        {
            EnumItems(pContainer);
            pContainer->Release();
        }
    }
    return hr;
}

//
// Enumerate the items in a container.
//
HRESULT EnumItems(
    IOfflineFilesItemContainer *pContainer
    )
{
    IEnumOfflineFilesItems *pEnum;
    HRESULT hr = pContainer->EnumItems(0, &pEnum);
    if (SUCCEEDED(hr))
    {
        IOfflineFilesItem *pItem;
        ULONG celt;
        while(S_OK == (hr = pEnum->Next(1, &pItem, &celt)))
        {
            ProcessItem(pItem);
            pItem->Release();
        }
        pEnum->Release();
    }
    return hr;
}

HRESULT EnumItemsInCache(
    IOfflineFilesCache *pCache
    )
{
    //
    // The "cache" object is a container of "server" items.
    //
    IOfflineFilesItemContainer *pContainer;
    HRESULT hr = pCache->QueryInterface(IID_IOfflineFilesItemContainer,
                                        (void **)&pContainer);
    if (SUCCEEDED(hr))
    {
        hr = EnumItems(pContainer);
    }
    return hr;
}

int wmain(int argc, __in_ecount(argc) WCHAR* argv[])
{
    HRESULT hr = CoInitialize(NULL);
    if (SUCCEEDED(hr))
    {
        //
        // The "cache" object is the entry point into the
        // Offline Files COM API.
        //
        IOfflineFilesCache *pCache;
        hr = CoCreateInstance(CLSID_OfflineFilesCache,
                              NULL,
                              CLSCTX_INPROC_SERVER,
                              IID_IOfflineFilesCache,
                              (void **)&pCache);
        if (SUCCEEDED(hr))
        {
            hr = EnumItemsInCache(pCache);
            pCache->Release();
        }
        CoUninitialize();
    }
    return 0;
}

このメソッドを実装するキャッシュ項目の子項目の列挙子を返します。(IOfflineFilesItemContainer.EnumItemsEx)

成功した場合は S_OK を、それ以外の場合はエラー値を返します。

キャッシュ全体をトップダウンで列挙するには、次の手順を実行します。

1. CLSID_OfflineFilesCache のインスタンスを作成し、その IOfflineFilesItemContainer インターフェイスを取得します。
2. EnumItemsEx メソッドを呼び出して、サーバーエントリの列挙子を取得します。
3. 返された各エントリに対して、IOfflineFilesItemContainer を要求する QueryInterface を呼び出します。
4. QueryInterface が成功した場合、その項目は子をサポートしています。その場合は各子を列挙し、それぞれに対して IOfflineFilesItemContainer を要求する QueryInterface を呼び出します。このパターンを再帰的に適用することで、キャッシュ全体を列挙できます。

表が示すように、除外フィルターに一致する場合、または包含フィルターに一致しない場合、その項目は列挙から除外されます。項目が列挙に含まれるには、除外フィルターに一致せず、かつ包含フィルターに一致する必要があります。