Win32 API 日本語リファレンス
ホーム › UI.Shell.PropertiesSystem › IPersistSerializedPropStorage2

IPersistSerializedPropStorage2

COM
📘 Microsoft Learn (日本語) · English
IID77effa68-4f98-4366-ba72-573b3d880571継承元IPersistSerializedPropStorage自前メソッド開始 vtbl6

公式ドキュメント

シリアル化されたプロパティストレージデータを後で使用するために永続化し、永続化されたデータを新しいプロパティストアインスタンスに復元するためのメソッドを公開します。(IPersistSerializedPropStorage2)

解説(Remarks)

このインターフェイスは、継承元である IPersistSerializedPropStorage インターフェイスのメソッドも提供します。

実装するタイミング

IPersistSerializedPropStorage2 は独自実装を目的としたものではありません。インメモリプロパティストアに関連付けられた、システム提供の実装を使用してください。

使用するタイミング

PSCreateMemoryPropertyStore を呼び出して作成されるインメモリプロパティストアは、このインターフェイスの実装を提供します。シリアル化されたプロパティストレージデータを永続化または復元したい場合に、この実装を使用してください。

メソッド 2

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

vtbl 6 HRESULT GetPropertyStorageSize(DWORD* pcb)

プロパティストアインスタンスから、シリアル化されたプロパティストレージデータのサイズを取得します。

pcbDWORD*outシリアル化されたプロパティストレージデータに含まれるバイト数。

戻り値

型: HRESULT

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

vtbl 7 HRESULT GetPropertyStorageBuffer(SERIALIZEDPROPSTORAGE* psps, DWORD cb, DWORD* pcbWritten)

プロパティストアインスタンスから、シリアル化されたプロパティストレージバッファを取得します。

pspsSERIALIZEDPROPSTORAGE*outこのメソッドが正常に返ると、プロパティストレージバッファの内容が格納されます。
cbDWORDinpsps が指すバッファの初期サイズ(バイト単位)。
pcbWrittenDWORD*outpsps が指すシリアル化されたプロパティストレージバッファに含まれるバイト数。

戻り値

型: HRESULT

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

解説(Remarks)

cb がシリアル化されたデータの合計サイズより小さい場合、このメソッドはエラーを返します。

SERIALIZEDPROPSTORAGE 型は Propsys.h において不完全型として定義されています。これは BYTE 値の配列として扱うべきであり、返されるデータの形式は規定されていません。SERIALIZEDPROPSTORAGE 構造体の内容は、ディスクやその他のストレージへの永続化に適しており、IPersistSerializedPropStorage::SetPropertyStorage を通じて別のプロパティストアを初期化するために使用できます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IPersistSerializedPropStorage2 "{77EFFA68-4F98-4366-BA72-573B3D880571}"
#usecom global IPersistSerializedPropStorage2 IID_IPersistSerializedPropStorage2 "{}"
#comfunc global IPersistSerializedPropStorage2_GetPropertyStorageSize    6 var
#comfunc global IPersistSerializedPropStorage2_GetPropertyStorageBuffer  7 var,int,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。