CryptXmlAddObject 関数 (cryptxml.h)

CryptXmlAddObject 関数は、エンコード用に開かれたドキュメント コンテキストの Signature に Object 要素を追加します。

構文

HRESULT CryptXmlAddObject(
  [in]            HCRYPTXML                hSignatureOrObject,
                  DWORD                    dwFlags,
  [in, optional]  const CRYPT_XML_PROPERTY *rgProperty,
  [in]            ULONG                    cProperty,
  [in]            const CRYPT_XML_BLOB     *pEncoded,
  [out, optional] const CRYPT_XML_OBJECT   **ppObject
);

パラメーター

[in] hSignatureOrObject

CryptXmlOpenToEncode 関数によって返される Signature のハンドル、または CRYPT_XML_FLAG_CREATE_REFERENCE_AS_OBJECT フラグが設定された CryptXmlCreateReference 関数によって返される Reference のハンドル。

dwFlags

オブジェクトを追加する方法を制御するフラグを指定します。

現在定義されている dwFlags 値を次の表に示します。

値	意味
CRYPT_XML_ADD_OBJECT_CREATE_REFERENCE	設定すると、XML パーツのメモリ内コピーが作成され、 Object 要素に含まれます。

[in, optional] rgProperty

Object 要素のデコードに使用される追加のプロパティを指定するCRYPT_XML_PROPERTY構造体へのポインター。

[in] cProperty

rgProperty プロパティが指す配列内の要素の数。

[in] pEncoded

Object 要素を含むCRYPT_XML_BLOB構造体へのポインター。

[out, optional] ppObject

デコードされた構造体を受け取る CRYPT_XML_OBJECT 構造体へのポインター。 hSignatureOrObject パラメーターに Object へのハンドルが含まれている場合、このパラメーターは NULL である必要があります。

戻り値

関数が成功した場合、関数は 0 を返します。

関数が失敗した場合は、エラーを示す HRESULT 値を返します。

注釈

hSignatureOrObject パラメーターが CryptXmlCreateReference 関数によって返される Reference へのハンドルを指定する場合、pEncoded パラメーターは、オプションの Manifest 要素の後の Object ノードに含まれる XML コンテンツを指定します。 pEncoded パラメーターに含まれるポインターは、署名が完了するまで有効である必要があります。 それ以外の場合は、 CRYPT_XML_FLAG_ADD_OBJECT_CREATE_COPY フラグを使用してメモリ内コピーを作成します。

要件

要件	値
サポートされている最小のクライアント	Windows 7 [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows Server 2008 R2 [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	cryptxml.h
Library	Cryptxml.lib
[DLL]	Cryptxml.dll