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

IOpcSignaturePartReference

COM
IIDe24231ca-59f4-484e-b64b-36eeda36072c継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

署名済みの、または署名対象となるパートへの参照を表します。

解説(Remarks)

IOpcSignaturePartReference インターフェイス ポインターで参照できるのは、IOpcPart インターフェイスで表現できるパートのみです。リレーションシップ パートは、署名のために IOpcSignatureRelationshipReference インターフェイスへのポインターで参照します。IOpcSignatureRelationshipReference インターフェイス ポインターを作成するには、IOpcSignatureRelationshipReferenceSet::Create メソッドを呼び出します。

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

IOpcSignaturePartReference インターフェイス ポインターにアクセスするには、IOpcSignaturePartReferenceEnumerator::GetCurrent メソッドを呼び出します。

このインターフェイスは、参照先のパートおよび参照自体に関する情報にアクセスするためのメソッドを提供します。署名が生成されると、この参照情報は署名の XML マークアップ (署名マークアップ) にシリアル化されます。署名マークアップでは、この情報は Reference 要素で表され、その URI 属性の値には参照先パートのパート名が設定されます。

次のマークアップは、これらの Reference 要素が署名マークアップ内の Manifest 要素の子であることを示しています。

// 署名の XML マークアップ
<Signature>
    [...]
    // パッケージ固有の <Object>
    <Object Id="idPackageObject">
        // この <Manifest> 要素には署名対象のパートが 1 つだけ含まれます。 
        <Manifest>
            // 署名対象パートへの参照。
            <Reference URI="aPartName">
                [...]
            </Reference>
        </Manifest>
        [...]
    </Object>
    [...]
</Signature>

スレッド セーフティ

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

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

メソッド 5

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

vtbl 3 HRESULT GetPartName(IOpcPartUri** partName)

参照先パートのパート名を取得します。

partNameIOpcPartUri**outパート名を表す IOpcPartUri インターフェイスへのポインター。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
E_POINTER
partName パラメーターが NULL です。
vtbl 4 HRESULT GetContentType(LPWSTR* contentType)

参照先パートのコンテンツ タイプを取得します。

contentTypeLPWSTR*out参照先パートのコンテンツ タイプ。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
E_POINTER
contentType パラメーターが NULL です。

解説(Remarks)

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

スレッド セーフティ

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

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

vtbl 5 HRESULT GetDigestMethod(LPWSTR* digestMethod)

参照先パートに署名する際に、そのパート コンテンツに対して使用するダイジェスト メソッドを取得します。

digestMethodLPWSTR*out参照先パートに署名する際に、そのパート コンテンツに対して使用するダイジェスト メソッド。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
E_POINTER
digestMethod パラメーターが NULL です。

解説(Remarks)

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

スレッド セーフティ

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

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

vtbl 6 HRESULT GetDigestValue(BYTE** digestValue, DWORD* count)

参照先パートに署名する際に、そのパート コンテンツに対して計算されるダイジェスト値を取得します。

digestValueBYTE**out指定されたダイジェスト メソッドを使用して計算されたダイジェスト値を格納するバッファーへのポインター。このメソッドは、参照先パートへの署名時にそのパート コンテンツに適用されます。
countDWORD*out

digestValue バッファーのサイズ。

参照先パートがまだ署名されていない場合、count は 0 になります。

戻り値

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

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

解説(Remarks)

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

スレッド セーフティ

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

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

vtbl 7 HRESULT GetTransformMethod(OPC_CANONICALIZATION_METHOD* transformMethod)

参照先パートに署名する際に、そのパート コンテンツに対して使用する正規化 (canonicalization) メソッドを取得します。

transformMethodOPC_CANONICALIZATION_METHOD*out参照先パートに署名する際に、そのパート コンテンツに対して使用する正規化 (canonicalization) メソッド。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
E_POINTER
transformMethod パラメーターが NULL です。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IOpcSignaturePartReference "{E24231CA-59F4-484E-B64B-36EEDA36072C}"
#usecom global IOpcSignaturePartReference IID_IOpcSignaturePartReference "{}"
#comfunc global IOpcSignaturePartReference_GetPartName         3 sptr
#comfunc global IOpcSignaturePartReference_GetContentType      4 var
#comfunc global IOpcSignaturePartReference_GetDigestMethod     5 var
#comfunc global IOpcSignaturePartReference_GetDigestValue      6 var,var
#comfunc global IOpcSignaturePartReference_GetTransformMethod  7 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。