Win32 API 日本語リファレンス
ホームSecurity.Cryptography › CryptXmlEncode

CryptXmlEncode

関数
XML署名をコールバック経由で指定文字コードにエンコード出力する。
DLLCRYPTXML.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT CryptXmlEncode(
    void* hCryptXml,
    CRYPT_XML_CHARSET dwCharset,
    const CRYPT_XML_PROPERTY* rgProperty,   // optional
    DWORD cProperty,
    void* pvCallbackState,
    PFN_CRYPT_XML_WRITE_CALLBACK pfnWrite
);

パラメーター

名前方向
hCryptXmlvoid*in
dwCharsetCRYPT_XML_CHARSETin
rgPropertyCRYPT_XML_PROPERTY*inoptional
cPropertyDWORDin
pvCallbackStatevoid*inout
pfnWritePFN_CRYPT_XML_WRITE_CALLBACKin

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT CryptXmlEncode(
    void* hCryptXml,
    CRYPT_XML_CHARSET dwCharset,
    const CRYPT_XML_PROPERTY* rgProperty,   // optional
    DWORD cProperty,
    void* pvCallbackState,
    PFN_CRYPT_XML_WRITE_CALLBACK pfnWrite
);
[DllImport("CRYPTXML.dll", ExactSpelling = true)]
static extern int CryptXmlEncode(
    IntPtr hCryptXml,   // void*
    int dwCharset,   // CRYPT_XML_CHARSET
    IntPtr rgProperty,   // CRYPT_XML_PROPERTY* optional
    uint cProperty,   // DWORD
    IntPtr pvCallbackState,   // void* in/out
    IntPtr pfnWrite   // PFN_CRYPT_XML_WRITE_CALLBACK
);
<DllImport("CRYPTXML.dll", ExactSpelling:=True)>
Public Shared Function CryptXmlEncode(
    hCryptXml As IntPtr,   ' void*
    dwCharset As Integer,   ' CRYPT_XML_CHARSET
    rgProperty As IntPtr,   ' CRYPT_XML_PROPERTY* optional
    cProperty As UInteger,   ' DWORD
    pvCallbackState As IntPtr,   ' void* in/out
    pfnWrite As IntPtr   ' PFN_CRYPT_XML_WRITE_CALLBACK
) As Integer
End Function
' hCryptXml : void*
' dwCharset : CRYPT_XML_CHARSET
' rgProperty : CRYPT_XML_PROPERTY* optional
' cProperty : DWORD
' pvCallbackState : void* in/out
' pfnWrite : PFN_CRYPT_XML_WRITE_CALLBACK
Declare PtrSafe Function CryptXmlEncode Lib "cryptxml" ( _
    ByVal hCryptXml As LongPtr, _
    ByVal dwCharset As Long, _
    ByVal rgProperty As LongPtr, _
    ByVal cProperty As Long, _
    ByVal pvCallbackState As LongPtr, _
    ByVal pfnWrite As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CryptXmlEncode = ctypes.windll.cryptxml.CryptXmlEncode
CryptXmlEncode.restype = ctypes.c_int
CryptXmlEncode.argtypes = [
    ctypes.POINTER(None),  # hCryptXml : void*
    ctypes.c_int,  # dwCharset : CRYPT_XML_CHARSET
    ctypes.c_void_p,  # rgProperty : CRYPT_XML_PROPERTY* optional
    wintypes.DWORD,  # cProperty : DWORD
    ctypes.POINTER(None),  # pvCallbackState : void* in/out
    ctypes.c_void_p,  # pfnWrite : PFN_CRYPT_XML_WRITE_CALLBACK
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPTXML.dll')
CryptXmlEncode = Fiddle::Function.new(
  lib['CryptXmlEncode'],
  [
    Fiddle::TYPE_VOIDP,  # hCryptXml : void*
    Fiddle::TYPE_INT,  # dwCharset : CRYPT_XML_CHARSET
    Fiddle::TYPE_VOIDP,  # rgProperty : CRYPT_XML_PROPERTY* optional
    -Fiddle::TYPE_INT,  # cProperty : DWORD
    Fiddle::TYPE_VOIDP,  # pvCallbackState : void* in/out
    Fiddle::TYPE_VOIDP,  # pfnWrite : PFN_CRYPT_XML_WRITE_CALLBACK
  ],
  Fiddle::TYPE_INT)
#[link(name = "cryptxml")]
extern "system" {
    fn CryptXmlEncode(
        hCryptXml: *mut (),  // void*
        dwCharset: i32,  // CRYPT_XML_CHARSET
        rgProperty: *const CRYPT_XML_PROPERTY,  // CRYPT_XML_PROPERTY* optional
        cProperty: u32,  // DWORD
        pvCallbackState: *mut (),  // void* in/out
        pfnWrite: *const core::ffi::c_void  // PFN_CRYPT_XML_WRITE_CALLBACK
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("CRYPTXML.dll")]
public static extern int CryptXmlEncode(IntPtr hCryptXml, int dwCharset, IntPtr rgProperty, uint cProperty, IntPtr pvCallbackState, IntPtr pfnWrite);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPTXML_CryptXmlEncode' -Namespace Win32 -PassThru
# $api::CryptXmlEncode(hCryptXml, dwCharset, rgProperty, cProperty, pvCallbackState, pfnWrite)
#uselib "CRYPTXML.dll"
#func global CryptXmlEncode "CryptXmlEncode" sptr, sptr, sptr, sptr, sptr, sptr
; CryptXmlEncode hCryptXml, dwCharset, varptr(rgProperty), cProperty, pvCallbackState, pfnWrite   ; 戻り値は stat
; hCryptXml : void* -> "sptr"
; dwCharset : CRYPT_XML_CHARSET -> "sptr"
; rgProperty : CRYPT_XML_PROPERTY* optional -> "sptr"
; cProperty : DWORD -> "sptr"
; pvCallbackState : void* in/out -> "sptr"
; pfnWrite : PFN_CRYPT_XML_WRITE_CALLBACK -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "CRYPTXML.dll"
#cfunc global CryptXmlEncode "CryptXmlEncode" sptr, int, var, int, sptr, sptr
; res = CryptXmlEncode(hCryptXml, dwCharset, rgProperty, cProperty, pvCallbackState, pfnWrite)
; hCryptXml : void* -> "sptr"
; dwCharset : CRYPT_XML_CHARSET -> "int"
; rgProperty : CRYPT_XML_PROPERTY* optional -> "var"
; cProperty : DWORD -> "int"
; pvCallbackState : void* in/out -> "sptr"
; pfnWrite : PFN_CRYPT_XML_WRITE_CALLBACK -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT CryptXmlEncode(void* hCryptXml, CRYPT_XML_CHARSET dwCharset, CRYPT_XML_PROPERTY* rgProperty, DWORD cProperty, void* pvCallbackState, PFN_CRYPT_XML_WRITE_CALLBACK pfnWrite)
#uselib "CRYPTXML.dll"
#cfunc global CryptXmlEncode "CryptXmlEncode" intptr, int, var, int, intptr, intptr
; res = CryptXmlEncode(hCryptXml, dwCharset, rgProperty, cProperty, pvCallbackState, pfnWrite)
; hCryptXml : void* -> "intptr"
; dwCharset : CRYPT_XML_CHARSET -> "int"
; rgProperty : CRYPT_XML_PROPERTY* optional -> "var"
; cProperty : DWORD -> "int"
; pvCallbackState : void* in/out -> "intptr"
; pfnWrite : PFN_CRYPT_XML_WRITE_CALLBACK -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	cryptxml = windows.NewLazySystemDLL("CRYPTXML.dll")
	procCryptXmlEncode = cryptxml.NewProc("CryptXmlEncode")
)

// hCryptXml (void*), dwCharset (CRYPT_XML_CHARSET), rgProperty (CRYPT_XML_PROPERTY* optional), cProperty (DWORD), pvCallbackState (void* in/out), pfnWrite (PFN_CRYPT_XML_WRITE_CALLBACK)
r1, _, err := procCryptXmlEncode.Call(
	uintptr(hCryptXml),
	uintptr(dwCharset),
	uintptr(rgProperty),
	uintptr(cProperty),
	uintptr(pvCallbackState),
	uintptr(pfnWrite),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function CryptXmlEncode(
  hCryptXml: Pointer;   // void*
  dwCharset: Integer;   // CRYPT_XML_CHARSET
  rgProperty: Pointer;   // CRYPT_XML_PROPERTY* optional
  cProperty: DWORD;   // DWORD
  pvCallbackState: Pointer;   // void* in/out
  pfnWrite: Pointer   // PFN_CRYPT_XML_WRITE_CALLBACK
): Integer; stdcall;
  external 'CRYPTXML.dll' name 'CryptXmlEncode';
result := DllCall("CRYPTXML\CryptXmlEncode"
    , "Ptr", hCryptXml   ; void*
    , "Int", dwCharset   ; CRYPT_XML_CHARSET
    , "Ptr", rgProperty   ; CRYPT_XML_PROPERTY* optional
    , "UInt", cProperty   ; DWORD
    , "Ptr", pvCallbackState   ; void* in/out
    , "Ptr", pfnWrite   ; PFN_CRYPT_XML_WRITE_CALLBACK
    , "Int")   ; return: HRESULT
●CryptXmlEncode(hCryptXml, dwCharset, rgProperty, cProperty, pvCallbackState, pfnWrite) = DLL("CRYPTXML.dll", "int CryptXmlEncode(void*, int, void*, dword, void*, void*)")
# 呼び出し: CryptXmlEncode(hCryptXml, dwCharset, rgProperty, cProperty, pvCallbackState, pfnWrite)
# hCryptXml : void* -> "void*"
# dwCharset : CRYPT_XML_CHARSET -> "int"
# rgProperty : CRYPT_XML_PROPERTY* optional -> "void*"
# cProperty : DWORD -> "dword"
# pvCallbackState : void* in/out -> "void*"
# pfnWrite : PFN_CRYPT_XML_WRITE_CALLBACK -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。