ホーム › UI.Shell › IStorageProviderPropertyHandler

IStorageProviderPropertyHandler

COM

📘 Microsoft Learn (日本語) · English

IID301dfbe5-524c-4b0f-8b2d-21c40b3a2988継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ファイルまたはフォルダーに関連付けられたプロパティのコレクションを提供します。

解説(Remarks)

注意

このインターフェイスは、実装する明確な必要がある場合にのみ実装してください。

このインターフェイスは、ファイルまたはファイルフォルダーに関するプロパティを共有するために、クラウドストレージプロバイダーの同期エンジンによって実装できます。IStorageProviderPropertyHandler のインスタンスは、同期ルート配下に作成されたストレージファイルのライフタイムの間存在します。個々のファイルまたはフォルダーに関連付けられたプロパティのセットを取得するには、IStorageProviderHandler を使用してください。

このインターフェイスは、以下のプロパティを追跡する役割を担います。

StorageProviderFileIdentifier
StorageProviderFileRemoteUri
StorageProviderFileChecksum
StorageProviderFileVersionWaterline

メソッド 2

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

vtbl 3 HRESULT RetrieveProperties(PROPERTYKEY* propertiesToRetrieve, DWORD propertiesToRetrieveCount, IPropertyStore** retrievedProperties)

同期エンジンによって管理されているプロパティを取得します。

propertiesToRetrieve	PROPERTYKEY*	in	取得するプロパティの識別子です。
propertiesToRetrieveCount	DWORD	in	取得するプロパティの数です。
retrievedProperties	IPropertyStore**	out	プロパティのコレクションです。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

ファイルまたはフォルダーが見つからない場合、このメソッドは S_OK を返すべきですが、retrievedProperties は空にする必要があります。

同期エンジンによって管理されていないプロパティについては、それらのプロパティに対して VT_EMPTY を返すべきです。

vtbl 4 HRESULT SaveProperties(IPropertyStore* propertiesToSave)

ファイルまたはフォルダーに関連付けられたプロパティを保存します。

propertiesToSave

IPropertyStore*

保存するプロパティです。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

同期エンジンによって管理されていないプロパティを保存しようとすると、エラーコード E_INVALIDARG となります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IStorageProviderPropertyHandler "{301DFBE5-524C-4B0F-8B2D-21C40B3A2988}"
#usecom global IStorageProviderPropertyHandler IID_IStorageProviderPropertyHandler "{}"
#comfunc global IStorageProviderPropertyHandler_RetrieveProperties  3 var,int,sptr
#comfunc global IStorageProviderPropertyHandler_SaveProperties      4 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IStorageProviderPropertyHandler "{301DFBE5-524C-4B0F-8B2D-21C40B3A2988}"
#usecom global IStorageProviderPropertyHandler IID_IStorageProviderPropertyHandler "{}"
#comfunc global IStorageProviderPropertyHandler_RetrieveProperties  3 sptr,int,sptr
#comfunc global IStorageProviderPropertyHandler_SaveProperties      4 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。