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

IWMDMEnumStorage

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

公式ドキュメント

IWMDMEnumStorage インターフェイスは、デバイス上のストレージを列挙します。

メソッド 4

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

vtbl 3 HRESULT Next(DWORD celt, IWMDMStorage** ppStorage, DWORD* pceltFetched)

Next メソッドは、次の兄弟ストレージへのポインターを取得します。

celtDWORDin要求するストレージの数。
ppStorageIWMDMStorage**out呼び出し元が割り当てた IWMDMStorage インターフェイスポインターの配列。この配列のサイズは IWMDMStorage *[celt] である必要があります。呼び出し元は、使用が終わったらこれらのインターフェイスを解放する必要があります。配列全体を割り当てたくない場合は、「解説」に示すように、IWMDMStorage インターフェイスへのポインターのアドレスを渡すだけで構いません。
pceltFetchedDWORD*out列挙されたストレージの数。

戻り値

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

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

解説(Remarks)

Windows Media Device Manager は、ストレージの列挙を対応するサービスプロバイダーに委譲します。サービスプロバイダーによるストレージ列挙については、IMDSPEnumStorage インターフェイスを参照してください。

ストレージ列挙子には、メディアの挿入や取り出しの結果が反映されないことがあります。その場合、アプリケーションは IWMDMDevice::EnumStorage を呼び出して新しいストレージ列挙子オブジェクトを取得し、更新された一覧を入手してください。一度に 1 つのインターフェイスだけを取得する場合は、次のコードに示すように、このメソッド用に配列を割り当てる必要はありません。

次の 2 つの C++ 関数は、デバイスを再帰的に探索します。1 つ目は、ルートデバイスストレージの IWMDMEnumStorage インターフェイスを取得する開始用の関数です。これを再帰関数に渡し、入れ子になったすべての要素を調べます。


// デバイスを探索するための開始関数。
void ExploreDevice(IWMDMDevice* pDevice)
{
    HRESULT hr = S_OK;

    // ルート列挙子を取得します。
    CComPtr<IWMDMEnumStorage> pEnumStorage;
    hr = pDevice->EnumStorage(&pEnumStorage);
    RecursiveExploreStorage(pEnumStorage);

    HANDLE_HR(hr, "Got a root storage in ExploreDevice.","Couldn't get a root storage in ExploreDevice.");

e_Exit:
    return;
}

void RecursiveExploreStorage(IWMDMEnumStorage* pEnumStorage)
{
    HRESULT hr = S_OK;
    CComPtr<IWMDMStorage> pStorage;
    ULONG numRetrieved = 0;
    // 現在のストレージ内のすべてのストレージをループ処理します。
    // 一度に 1 つのインターフェイスを取得する場合は、
    // 配列を割り当てる必要はありません。
    while(pEnumStorage->Next(1, &pStorage, &numRetrieved) == S_OK && numRetrieved == 1)
    {
        // オブジェクトの名前を取得します。デバイスに対して最初に呼び出したときは、
        // ルートフォルダー名として '\' が取得されます。
        const UINT MAX_LEN = 255;
        WCHAR name[MAX_LEN];
        hr = pStorage->GetName((LPWSTR)&name, MAX_LEN);
        // TODO: ストレージ名を表示します。

    
        // ストレージのメタデータを取得します。
        if (SUCCEEDED(hr))
            GetMetadata(pStorage);

        // 項目に関する情報を調べます。
        DWORD attributes = 0;
        _WAVEFORMATEX audioFormat;
        hr = pStorage->GetAttributes(&attributes, &audioFormat);
        HANDLE_HR(hr, "Got storage attributes in RecursivelyExploreStorage.","Couldn't get storage attributes in RecursivelyExploreStorage.");

        // フォルダーの場合は、再帰的に処理します。
        if (attributes & WMDM_FILE_ATTR_FILE)
            // TODO: これがファイルであることを示すメッセージを表示します。
        if (attributes & WMDM_FILE_ATTR_FOLDER)
        {
            // TODO: これがフォルダーであることを示すメッセージを表示します。
            CComPtr<IWMDMEnumStorage> pEnumSubStorage;
            hr = pStorage->EnumStorage(&pEnumSubStorage);
            RecursiveExploreStorage(pEnumSubStorage);
        }

        // 確認すると便利なその他の属性は次のとおりです。
        // WMDM_FILE_ATTR_CANDELETE や WMDM_FILE_ATTR_CANPLAY など: ストレージに対して何ができるかを判断します。
        // WMDM_FILE_ATTR_HIDDEN などの属性: 表示に関する特性を判断します。
        // WMDM_STORAGE_IS_DEFAULT: 新しいファイルの既定の保存先かどうかを確認します。
        pStorage.Release();
    } // 次のストレージポインターを取得します。

e_Exit:
    return;
}
vtbl 4 HRESULT Skip(DWORD celt, DWORD* pceltFetched)

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

celtDWORDinスキップするストレージの数。
pceltFetchedDWORD*outスキップされたストレージの数。

戻り値

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

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

解説(Remarks)

celt で指定された数が、列挙シーケンスに残っているストレージインターフェイスの実際の数より多い場合、この関数は S_FALSE を返します。この場合は、pceltFetched を確認して、実際に何個のインターフェイスがスキップされたかを判断する必要があります。ストレージインターフェイスの配列の末尾までスキップした場合、その後の Next の呼び出しは S_FALSE を返します。

vtbl 5 HRESULT Reset()

Reset メソッドは、列挙シーケンスを先頭に戻します。

戻り値

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

発生し得るエラーコードの詳細な一覧については、Error Codes を参照してください。
vtbl 6 HRESULT Clone(IWMDMEnumStorage** ppEnumStorage)

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

ppEnumStorageIWMDMEnumStorage**out複製された列挙子の IWMDMEnumStorage インターフェイス。呼び出し元は、使用が終わったらこのインターフェイスを解放する必要があります。

戻り値

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