ホーム › Storage.Xps › IXpsSignatureBlock

IXpsSignatureBlock

COM

📘 Microsoft Learn (日本語) · English

IID151fac09-0b97-4ac6-a323-5e4297d4322b継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

SignatureDefinitions パートに格納される署名要求のブロックを表します。

解説(Remarks)

このインターフェイスは、それをインスタンス化した署名マネージャーから独立して存在することはできません。

メソッド 5

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

vtbl 3 HRESULT GetRequests(IXpsSignatureRequestCollection** requests)

署名要求のコレクションを保持する IXpsSignatureRequestCollection インターフェイスへのポインターを取得します。

requests

IXpsSignatureRequestCollection**

out

署名要求のコレクションを保持する IXpsSignatureRequestCollection インターフェイスへのポインター。

戻り値

このメソッドは HRESULT を返します。返される可能性のある値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない戻り値については、XPS Digital Signature API Errors および XPS Document Errors を参照してください。

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	requests が NULL です。
E_UNEXPECTED	インターフェイスが署名マネージャーに接続されていません。

解説(Remarks)

署名要求は、LoadPackageFile または LoadPackageStream が XPS パッケージを読み取るときに、対応する SignatureDefinitions パートの XML マークアップを解析することによって、署名要求のコレクションに追加されます。

vtbl 4 HRESULT GetPartName(IOpcPartUri** partName)

SignatureDefinitions パートの URI を保持する IOpcPartUri インターフェイスへのポインターを取得します。

partName

IOpcPartUri**

out

SignatureDefinitions パートの URI を保持する IOpcPartUri インターフェイスへのポインター。

戻り値

戻り値	説明
E_POINTER	partName が NULL です。
E_UNEXPECTED	インターフェイスが署名マネージャーに接続されていません。

vtbl 5 HRESULT GetDocumentIndex(DWORD* fixedDocumentIndex)

この署名ブロックに対応する SignatureDefinitions パートを参照している FixedDocument パートのインデックスを取得します。

fixedDocumentIndex

DWORD*

out

この SignatureBlock に対応する SignatureDefinitions パートを参照している FixedDocument パートの、0 から始まるインデックス。

戻り値

戻り値	説明
E_POINTER	fixedDocumentIndex が NULL です。
E_UNEXPECTED	インターフェイスが署名マネージャーに接続されていません。

vtbl 6 HRESULT GetDocumentName(IOpcPartUri** fixedDocumentName)

ドキュメントパートの URI を保持する IOpcPartUri インターフェイスへのポインターを取得します。

fixedDocumentName

IOpcPartUri**

out

ドキュメントパートの URI を保持する IOpcPartUri インターフェイスへのポインター。

戻り値

戻り値	説明
E_POINTER	fixedDocumentName が NULL です。
E_UNEXPECTED	インターフェイスが署名マネージャーに接続されていません。

vtbl 7 HRESULT CreateRequest(LPWSTR requestId, IXpsSignatureRequest** signatureRequest)

新しい IXpsSignatureRequest インターフェイスを作成し、署名ブロックに追加します。

requestId	LPWSTR	in	署名ブロック内で新しい署名要求を一意に識別する文字列。メソッドに ID 文字列を生成させるには、このパラメーターに NULL を設定します。
signatureRequest	IXpsSignatureRequest**	out	新しい IXpsSignatureRequest インターフェイスへのポインター。新しい要求インターフェイスへのアクセスが不要な場合、このパラメーターには NULL を設定できます。

戻り値

戻り値	説明
S_OK	メソッドは成功しました。
E_UNEXPECTED	インターフェイスが署名マネージャーに接続されていないか、requestId が NULL であり、一意の ID 文字列を生成できませんでした。

解説(Remarks)

新しい署名要求には一意の要求 ID が必要です。2 つの要求が同じ ID 文字列を持つことはできません。

新しい要求を作成すると、署名ブロックはダーティとしてマークされ、SignatureDefinitions パートの新しいコンテンツが生成されます。XPS パッケージがシリアル化されると、新しいコンテンツが SignatureDefinitions パートの以前のコンテンツを上書きします。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IXpsSignatureBlock "{151FAC09-0B97-4AC6-A323-5E4297D4322B}"
#usecom global IXpsSignatureBlock IID_IXpsSignatureBlock "{}"
#comfunc global IXpsSignatureBlock_GetRequests       3 sptr
#comfunc global IXpsSignatureBlock_GetPartName       4 sptr
#comfunc global IXpsSignatureBlock_GetDocumentIndex  5 var
#comfunc global IXpsSignatureBlock_GetDocumentName   6 sptr
#comfunc global IXpsSignatureBlock_CreateRequest     7 wstr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IXpsSignatureBlock "{151FAC09-0B97-4AC6-A323-5E4297D4322B}"
#usecom global IXpsSignatureBlock IID_IXpsSignatureBlock "{}"
#comfunc global IXpsSignatureBlock_GetRequests       3 sptr
#comfunc global IXpsSignatureBlock_GetPartName       4 sptr
#comfunc global IXpsSignatureBlock_GetDocumentIndex  5 sptr
#comfunc global IXpsSignatureBlock_GetDocumentName   6 sptr
#comfunc global IXpsSignatureBlock_CreateRequest     7 wstr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。