Win32 API 日本語リファレンス
ホーム › Storage.Packaging.Opc › IOpcSignatureCustomObject

IOpcSignatureCustomObject

COM
📘 Microsoft Learn (日本語) · English
IID5d77a19e-62c1-44e7-becd-45da5ae51a56継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

署名済み、または署名される予定の、アプリケーション固有の Object 要素を表します。

解説(Remarks)

IOpcSignatureCustomObject インターフェイスポインターは、それが表す Object 要素の XML マークアップへのアクセスを提供します。Object 要素の XML マークアップにアクセスするには、IOpcSignatureCustomObject::GetXml メソッドを呼び出します。

署名マークアップ内でシリアル化されたアプリケーション固有の Object 要素は、署名マークアップを置き換えることによって追加、削除、または変更できます。

署名マークアップを置き換えるには、IOpcDigitalSignatureManager::ReplaceSignatureXml メソッドを呼び出します。アプリケーション固有の Object 要素の追加、削除、変更によって署名が壊れないようにするのは、呼び出し元の責任です。

アプリケーション固有の Object 要素またはその子要素に署名するには、署名対象の要素への参照を作成します。参照を作成するには、IOpcSignatureReferenceSet::Create メソッドを呼び出し、referenceUri パラメーターの値に "#" と参照先要素の Id 属性値を続けた文字列を指定します。たとえば、参照先要素の Id 属性が "Application" の場合、referenceUri には "#Application" を設定します。

IOpcSignatureCustomObject インターフェイスポインターを作成するには、IOpcSignatureCustomObjectSet::Create メソッドを呼び出します。

IOpcSignatureCustomObject インターフェイスポインターを取得するには、IOpcSignatureCustomObjectEnumerator::GetCurrent メソッドを呼び出します。

署名が生成されると、アプリケーション固有の Object 要素のマークアップが署名マークアップに含まれます。

アプリケーション固有の Object 要素は、パッケージ署名において必須ではありません。

スレッドセーフティ

パッケージング関連のオブジェクトはスレッドセーフではありません。

詳細については、Getting Started with the Packaging API を参照してください。

メソッド 1

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

vtbl 3 HRESULT GetXml(BYTE** xmlMarkup, DWORD* count)

アプリケーション固有の Object 要素の XML マークアップを取得します。

xmlMarkupBYTE**out

Object 要素の XML マークアップを格納するバッファーへのポインター。マークアップには開始タグと終了タグの Object タグが含まれます。

バッファー内では、XML マークアップの前に、そのマークアップのエンコーディングに対応する バイトオーダーマーク が付加されます。

サポートされるエンコーディングと バイトオーダーマーク の値は次のとおりです。

エンコーディング 説明 バイトオーダーマーク
UTF8 UTF-8 EF BB BF
UTF16LE UTF-16、リトルエンディアン FF FE
UTF16BE UTF-16、ビッグエンディアン FE FF

バイトオーダーマーク を含むバッファーの例については、「解説」セクションを参照してください。

countDWORD*outxmlMarkup バッファーのサイズへのポインター。

戻り値

このメソッドは HRESULT を返します。戻り値には、次の表に示すものを含みますが、これらに限定されません。

戻り値 説明
S_OK
 メソッドは成功しました。
E_POINTER
 xmlMarkup および count パラメーターの少なくとも 1 つが NULL です。

解説(Remarks)

このメソッドは、xmlMarkup で返されるバッファーが使用するメモリを割り当てます。メソッドが成功した場合は、CoTaskMemFree 関数を呼び出してメモリを解放してください。

署名マークアップ内でシリアル化されたアプリケーション固有の Object 要素は、署名マークアップを置き換えることによって追加、削除、または変更できます。

署名マークアップを置き換えるには、IOpcDigitalSignatureManager::ReplaceSignatureXml メソッドを呼び出します。アプリケーション固有の Object 要素の追加、削除、変更によって署名が壊れないようにするのは、呼び出し元の責任です。

アプリケーション固有の Object 要素またはその子要素に署名するには、署名対象の XML 要素への参照を作成します。参照を作成するには、IOpcSignatureReferenceSet::Create メソッドを呼び出し、referenceUri パラメーターの値に "#" と参照先要素の Id 属性値を続けた文字列を指定します。たとえば、参照先要素の Id 属性が "Application" の場合、referenceUri には "#Application" を設定します。

次の表は、"<Object Id="id1"></Object>" を格納する xmlMarkup バッファーの先頭にある バイトオーダーマーク を示しています。

バッファーのバイトインデックス 0 1 2 3 4 5 6 7 ...
UTF8 の値 EF BB BF '<' 'O' 'b' 'j' 'e' ...
UTF16LE の値 FF FE '<' 00 'O' 00 'b' 00 ...

スレッドセーフティ

パッケージング関連のオブジェクトはスレッドセーフではありません。

詳細については、Getting Started with the Packaging API を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IOpcSignatureCustomObject "{5D77A19E-62C1-44E7-BECD-45DA5AE51A56}"
#usecom global IOpcSignatureCustomObject IID_IOpcSignatureCustomObject "{}"
#comfunc global IOpcSignatureCustomObject_GetXml  3 var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。