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

IInitializeWithStream

COM
IIDb824b49d-22ac-4161-ac8a-9916e8fa3f7f継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

プロパティハンドラー、サムネイルハンドラー、プレビューハンドラーなどのハンドラーをストリームで初期化するメソッドを公開します。

メソッド 1

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

vtbl 3 HRESULT Initialize(IStream* pstream, DWORD grfMode)

ハンドラーをストリームで初期化します。

pstreamIStream*inストリームソースを表す IStream インターフェースへのポインター。
grfModeDWORDin

pstream のアクセスモードを示す、次の STGM 値のいずれか。

STGM_READ

pstream が示すストリームは読み取り専用です。

STGM_READWRITE

pstream が示すストリームは読み取り/書き込みが可能です。

戻り値

Type: HRESULT

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

解説(Remarks)

このメソッドは、.zip ファイル名拡張子を持つ圧縮ファイルの内容など、Win32 パスからアクセスできないストリームを使用できるため、Initialize よりも推奨されます。

pstream が指すストリームは、ハンドラーの存続期間中、または IPropertyStore::Commit が呼び出されるまで開いたままにしておく必要があります。

最初に開かれたとき、ソースストリームの参照はストリームの先頭を指します。ハンドラーは任意のタイミングでストリームをシークして読み取ることができます。ハンドラーは、Initialize の実行中にストリームからすべてのプロパティを読み取るように実装することも、呼び出し元プロセスがプロパティの列挙または読み取りを試みるまで待ってからストリームから取得するように実装することもできます。

ハンドラーのインスタンスは、その存続期間中に一度だけ初期化する必要があります。呼び出し元がハンドラーの再初期化を試みると、エラー HRESULT_FROM_WIN32(ERROR_ALREADY_INITIALIZED) が返されます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IInitializeWithStream "{B824B49D-22AC-4161-AC8A-9916E8FA3F7F}"
#usecom global IInitializeWithStream IID_IInitializeWithStream "{}"
#comfunc global IInitializeWithStream_Initialize  3 sptr,int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。