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

IMDSPEnumStorage

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

公式ドキュメント

IMDSPEnumStorage インターフェイスは、デバイス上のストレージメディアを列挙するために使用します。

メソッド 4

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

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

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

celtDWORDin要求するストレージインターフェイスの数。
ppStorageIMDSPStorage**out呼び出し元が割り当てた celt 個の IMDSPStorage インターフェイスポインターの配列。これ以上ストレージメディアが存在しない場合、またはエラーが発生した場合は NULL を返します。celt が 1 より大きい場合、呼び出し元は celt 個のインターフェイスポインターを格納できる十分なメモリを割り当てる必要があります。
pceltFetchedDWORD*out返されたインターフェイスの数を受け取る ULONG 変数へのポインター。

戻り値

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

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

解説(Remarks)

ストレージインターフェイスがこれ以上存在しない場合、または要求された数より少ない場合、Next の戻り値は S_FALSE になります。この場合は、pceltFetched パラメーターを確認して、インターフェイスが返されたかどうか、また何個返されたかを判断する必要があります。

ストレージ列挙子には、メディアの挿入や取り出しの結果が反映されないことがあります。そのような場合、クライアントは新しい列挙子オブジェクトを取得してください。

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

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

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

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

戻り値

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

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

解説(Remarks)

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

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

vtbl 5 HRESULT Reset()

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

戻り値

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

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

解説(Remarks)

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

vtbl 6 HRESULT Clone(IMDSPEnumStorage** ppEnumStorage)

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

ppEnumStorageIMDSPEnumStorage**outIMDSPEnumStorage インターフェイスへのポインター。

戻り値

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

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

解説(Remarks)

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

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

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