ホーム › Storage.Vss › IVssWriterComponents

IVssWriterComponents

COM

📘 Microsoft Learn (日本語) · English

自前メソッド開始 vtbl0

公式ドキュメント

コンポーネント情報の取得および変更に使用するメソッドを提供します。

メソッド 3

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

vtbl 0 HRESULT GetComponentCount(DWORD* pcComponents)

GetComponentCount メソッドは、指定したライターのコンポーネントのうち、Backup Components Document に明示的に格納されているものの数を返します。

pcComponents

DWORD*

inout

Backup Components Document に格納されているライターのコンポーネント数へのポインター。

戻り値

このメソッドの有効な戻り値は次のとおりです。

値	意味
S_OK	コンポーネントを正常に返しました。
E_INVALIDARG	いずれかのパラメーター値が無効です。
E_OUTOFMEMORY	呼び出し元のメモリまたはその他のシステムリソースが不足しています。

vtbl 1 HRESULT GetWriterInfo(GUID* pidInstance, GUID* pidWriter)

GetWriterInfo メソッドは、コンポーネントを担当するライターのインスタンス識別子およびクラス識別子を取得します。

pidInstance	GUID*	inout	ライターインスタンスの識別子。
pidWriter	GUID*	inout	ライタークラスの識別子。

戻り値

このメソッドの有効な戻り値は次のとおりです。

値	意味
S_OK	コンポーネントを正常に返しました。
E_INVALIDARG	いずれかのパラメーター値が無効です。
E_OUTOFMEMORY	呼び出し元のメモリまたはその他のシステムリソースが不足しています。
VSS_E_INVALID_XML_DOCUMENT	XML ドキュメントが無効です。詳細についてはイベントログを確認してください。詳細については、 Event and Error Handling Under VSS を参照してください。

vtbl 2 HRESULT GetComponent(DWORD iComponent, IVssComponent** ppComponent)

GetComponent メソッドは、指定したライターのコンポーネントのうち、Backup Components Document に明示的に格納されているものの 1 つに対する IVssComponent インターフェイスを返します。

iComponent	DWORD	in	コンポーネントの番号。このパラメーターの値は 0 から n–1 までの整数です。ここで n は IVssWriterComponents::GetComponentCount によって返されるコンポーネントの総数です。
ppComponent	IVssComponent**	out	コンポーネント情報を含む IVssComponent オブジェクトのインスタンスへの二重間接ポインター。

戻り値

このメソッドの有効な戻り値は次のとおりです。

値	意味
S_OK	コンポーネントを正常に返しました。
E_INVALIDARG	いずれかのパラメーター値が無効です。
E_OUTOFMEMORY	呼び出し元のメモリまたはその他のシステムリソースが不足しています。
VSS_E_OBJECT_NOT_FOUND	指定されたコンポーネントが見つかりませんでした。

解説(Remarks)

呼び出し元は、返された IVssComponent オブジェクトが保持するシステムリソースを解放するために、IUnknown::Release を呼び出す責任があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_IVssWriterComponents "{}"
#usecom global IVssWriterComponents IID_IVssWriterComponents "{}"
#comfunc global IVssWriterComponents_GetComponentCount  0 var
#comfunc global IVssWriterComponents_GetWriterInfo      1 var,var
#comfunc global IVssWriterComponents_GetComponent       2 int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IVssWriterComponents "{}"
#usecom global IVssWriterComponents IID_IVssWriterComponents "{}"
#comfunc global IVssWriterComponents_GetComponentCount  0 sptr
#comfunc global IVssWriterComponents_GetWriterInfo      1 sptr,sptr
#comfunc global IVssWriterComponents_GetComponent       2 int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。