ホーム › Security.Cryptography › CryptXmlAddObject

CryptXmlAddObject

関数

XML署名に署名対象のObject要素を追加する。

DLLCRYPTXML.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

// CRYPTXML.dll
#include <windows.h>

HRESULT CryptXmlAddObject(
    void* hSignatureOrObject,
    DWORD dwFlags,
    const CRYPT_XML_PROPERTY* rgProperty,   // optional
    DWORD cProperty,
    const CRYPT_XML_BLOB* pEncoded,
    const CRYPT_XML_OBJECT** ppObject
);

パラメーター

名前

型

方向

説明

hSignatureOrObject

void*

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

dwFlags

DWORD

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

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

値	意味
CRYPT_XML_ADD_OBJECT_CREATE_REFERENCE	設定されている場合、XML パートのメモリ内コピーが作成され、Object 要素に含められます。

rgProperty

CRYPT_XML_PROPERTY*

inoptional

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

cProperty

DWORD

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

pEncoded

CRYPT_XML_BLOB*

Object 要素を格納する CRYPT_XML_BLOB 構造体へのポインター。

ppObject

CRYPT_XML_OBJECT**

out

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

戻り値の型: HRESULT

公式ドキュメント

エンコード用に開かれた Document Context 内の Signature に Object 要素を追加します。

戻り値

関数が成功すると、ゼロを返します。

関数が失敗すると、エラーを示す HRESULT 値を返します。

解説(Remarks)

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

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

各言語での呼び出し定義

// CRYPTXML.dll
#include <windows.h>

HRESULT CryptXmlAddObject(
    void* hSignatureOrObject,
    DWORD dwFlags,
    const CRYPT_XML_PROPERTY* rgProperty,   // optional
    DWORD cProperty,
    const CRYPT_XML_BLOB* pEncoded,
    const CRYPT_XML_OBJECT** ppObject
);

[DllImport("CRYPTXML.dll", ExactSpelling = true)]
static extern int CryptXmlAddObject(
    IntPtr hSignatureOrObject,   // void*
    uint dwFlags,   // DWORD
    IntPtr rgProperty,   // CRYPT_XML_PROPERTY* optional
    uint cProperty,   // DWORD
    IntPtr pEncoded,   // CRYPT_XML_BLOB*
    IntPtr ppObject   // CRYPT_XML_OBJECT** out
);

<DllImport("CRYPTXML.dll", ExactSpelling:=True)>
Public Shared Function CryptXmlAddObject(
    hSignatureOrObject As IntPtr,   ' void*
    dwFlags As UInteger,   ' DWORD
    rgProperty As IntPtr,   ' CRYPT_XML_PROPERTY* optional
    cProperty As UInteger,   ' DWORD
    pEncoded As IntPtr,   ' CRYPT_XML_BLOB*
    ppObject As IntPtr   ' CRYPT_XML_OBJECT** out
) As Integer
End Function

' hSignatureOrObject : void*
' dwFlags : DWORD
' rgProperty : CRYPT_XML_PROPERTY* optional
' cProperty : DWORD
' pEncoded : CRYPT_XML_BLOB*
' ppObject : CRYPT_XML_OBJECT** out
Declare PtrSafe Function CryptXmlAddObject Lib "cryptxml" ( _
    ByVal hSignatureOrObject As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal rgProperty As LongPtr, _
    ByVal cProperty As Long, _
    ByVal pEncoded As LongPtr, _
    ByVal ppObject As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptXmlAddObject = ctypes.windll.cryptxml.CryptXmlAddObject
CryptXmlAddObject.restype = ctypes.c_int
CryptXmlAddObject.argtypes = [
    ctypes.POINTER(None),  # hSignatureOrObject : void*
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # rgProperty : CRYPT_XML_PROPERTY* optional
    wintypes.DWORD,  # cProperty : DWORD
    ctypes.c_void_p,  # pEncoded : CRYPT_XML_BLOB*
    ctypes.c_void_p,  # ppObject : CRYPT_XML_OBJECT** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPTXML.dll')
CryptXmlAddObject = Fiddle::Function.new(
  lib['CryptXmlAddObject'],
  [
    Fiddle::TYPE_VOIDP,  # hSignatureOrObject : void*
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # rgProperty : CRYPT_XML_PROPERTY* optional
    -Fiddle::TYPE_INT,  # cProperty : DWORD
    Fiddle::TYPE_VOIDP,  # pEncoded : CRYPT_XML_BLOB*
    Fiddle::TYPE_VOIDP,  # ppObject : CRYPT_XML_OBJECT** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "cryptxml")]
extern "system" {
    fn CryptXmlAddObject(
        hSignatureOrObject: *mut (),  // void*
        dwFlags: u32,  // DWORD
        rgProperty: *const CRYPT_XML_PROPERTY,  // CRYPT_XML_PROPERTY* optional
        cProperty: u32,  // DWORD
        pEncoded: *const CRYPT_XML_BLOB,  // CRYPT_XML_BLOB*
        ppObject: *const *const CRYPT_XML_OBJECT  // CRYPT_XML_OBJECT** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("CRYPTXML.dll")]
public static extern int CryptXmlAddObject(IntPtr hSignatureOrObject, uint dwFlags, IntPtr rgProperty, uint cProperty, IntPtr pEncoded, IntPtr ppObject);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPTXML_CryptXmlAddObject' -Namespace Win32 -PassThru
# $api::CryptXmlAddObject(hSignatureOrObject, dwFlags, rgProperty, cProperty, pEncoded, ppObject)

#uselib "CRYPTXML.dll"
#func global CryptXmlAddObject "CryptXmlAddObject" sptr, sptr, sptr, sptr, sptr, sptr
; CryptXmlAddObject hSignatureOrObject, dwFlags, varptr(rgProperty), cProperty, varptr(pEncoded), varptr(ppObject)   ; 戻り値は stat
; hSignatureOrObject : void* -> "sptr"
; dwFlags : DWORD -> "sptr"
; rgProperty : CRYPT_XML_PROPERTY* optional -> "sptr"
; cProperty : DWORD -> "sptr"
; pEncoded : CRYPT_XML_BLOB* -> "sptr"
; ppObject : CRYPT_XML_OBJECT** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPTXML.dll"
#cfunc global CryptXmlAddObject "CryptXmlAddObject" sptr, int, var, int, var, var
; res = CryptXmlAddObject(hSignatureOrObject, dwFlags, rgProperty, cProperty, pEncoded, ppObject)
; hSignatureOrObject : void* -> "sptr"
; dwFlags : DWORD -> "int"
; rgProperty : CRYPT_XML_PROPERTY* optional -> "var"
; cProperty : DWORD -> "int"
; pEncoded : CRYPT_XML_BLOB* -> "var"
; ppObject : CRYPT_XML_OBJECT** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPTXML.dll"
#cfunc global CryptXmlAddObject "CryptXmlAddObject" sptr, int, sptr, int, sptr, sptr
; res = CryptXmlAddObject(hSignatureOrObject, dwFlags, varptr(rgProperty), cProperty, varptr(pEncoded), varptr(ppObject))
; hSignatureOrObject : void* -> "sptr"
; dwFlags : DWORD -> "int"
; rgProperty : CRYPT_XML_PROPERTY* optional -> "sptr"
; cProperty : DWORD -> "int"
; pEncoded : CRYPT_XML_BLOB* -> "sptr"
; ppObject : CRYPT_XML_OBJECT** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。