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

CryptXmlDigestReference

関数
XML署名のReference対象に変換を適用しダイジェストを計算する。
DLLCRYPTXML.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT CryptXmlDigestReference(
    void* hReference,
    DWORD dwFlags,
    CRYPT_XML_DATA_PROVIDER* pDataProviderIn
);

パラメーター

名前方向説明
hReferencevoid*inReference 要素のハンドル。
dwFlagsDWORDin

変換の適用方法を制御する値を指定します。

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

意味
CRYPT_XML_REFERENCE_DATA_TRANSFORMED
0x00000001
処理エンジンが変換チェーンエンジンを適用せずにダイジェストを作成することを指定します。
pDataProviderInCRYPT_XML_DATA_PROVIDER*inデータプロバイダーを指定する CRYPT_XML_DATA_PROVIDER 構造体へのポインター。CryptXmlDigestReference 関数は常にデータプロバイダーの fpnClose 関数を呼び出します。

戻り値の型: HRESULT

公式ドキュメント

アプリケーションが、解決された参照のダイジェストを計算するために使用します。この関数はダイジェストを更新する前に変換を適用します。

戻り値

関数が成功した場合、ゼロを返します。

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

解説(Remarks)

CRYPT_XML_REFERENCE_DATA_TRANSFORMED フラグが設定されている場合、処理エンジンは変換チェーンエンジンを適用せずに、受信したデータを直接ダイジェストに追加します。

CryptXmlDigestReference 関数は常に、pDataProviderIn パラメーターが指す CRYPT_XML_DATA_PROVIDER 構造体の fpnClose メンバーが指す関数を呼び出します。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HRESULT CryptXmlDigestReference(
    void* hReference,
    DWORD dwFlags,
    CRYPT_XML_DATA_PROVIDER* pDataProviderIn
);
[DllImport("CRYPTXML.dll", ExactSpelling = true)]
static extern int CryptXmlDigestReference(
    IntPtr hReference,   // void*
    uint dwFlags,   // DWORD
    IntPtr pDataProviderIn   // CRYPT_XML_DATA_PROVIDER*
);
<DllImport("CRYPTXML.dll", ExactSpelling:=True)>
Public Shared Function CryptXmlDigestReference(
    hReference As IntPtr,   ' void*
    dwFlags As UInteger,   ' DWORD
    pDataProviderIn As IntPtr   ' CRYPT_XML_DATA_PROVIDER*
) As Integer
End Function
' hReference : void*
' dwFlags : DWORD
' pDataProviderIn : CRYPT_XML_DATA_PROVIDER*
Declare PtrSafe Function CryptXmlDigestReference Lib "cryptxml" ( _
    ByVal hReference As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal pDataProviderIn As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CryptXmlDigestReference = ctypes.windll.cryptxml.CryptXmlDigestReference
CryptXmlDigestReference.restype = ctypes.c_int
CryptXmlDigestReference.argtypes = [
    ctypes.POINTER(None),  # hReference : void*
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # pDataProviderIn : CRYPT_XML_DATA_PROVIDER*
]
require 'fiddle'
require 'fiddle/import'

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

var (
	cryptxml = windows.NewLazySystemDLL("CRYPTXML.dll")
	procCryptXmlDigestReference = cryptxml.NewProc("CryptXmlDigestReference")
)

// hReference (void*), dwFlags (DWORD), pDataProviderIn (CRYPT_XML_DATA_PROVIDER*)
r1, _, err := procCryptXmlDigestReference.Call(
	uintptr(hReference),
	uintptr(dwFlags),
	uintptr(pDataProviderIn),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function CryptXmlDigestReference(
  hReference: Pointer;   // void*
  dwFlags: DWORD;   // DWORD
  pDataProviderIn: Pointer   // CRYPT_XML_DATA_PROVIDER*
): Integer; stdcall;
  external 'CRYPTXML.dll' name 'CryptXmlDigestReference';
result := DllCall("CRYPTXML\CryptXmlDigestReference"
    , "Ptr", hReference   ; void*
    , "UInt", dwFlags   ; DWORD
    , "Ptr", pDataProviderIn   ; CRYPT_XML_DATA_PROVIDER*
    , "Int")   ; return: HRESULT
●CryptXmlDigestReference(hReference, dwFlags, pDataProviderIn) = DLL("CRYPTXML.dll", "int CryptXmlDigestReference(void*, dword, void*)")
# 呼び出し: CryptXmlDigestReference(hReference, dwFlags, pDataProviderIn)
# hReference : void* -> "void*"
# dwFlags : DWORD -> "dword"
# pDataProviderIn : CRYPT_XML_DATA_PROVIDER* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "cryptxml" fn CryptXmlDigestReference(
    hReference: ?*anyopaque, // void*
    dwFlags: u32, // DWORD
    pDataProviderIn: [*c]CRYPT_XML_DATA_PROVIDER // CRYPT_XML_DATA_PROVIDER*
) callconv(std.os.windows.WINAPI) i32;
proc CryptXmlDigestReference(
    hReference: pointer,  # void*
    dwFlags: uint32,  # DWORD
    pDataProviderIn: ptr CRYPT_XML_DATA_PROVIDER  # CRYPT_XML_DATA_PROVIDER*
): int32 {.importc: "CryptXmlDigestReference", stdcall, dynlib: "CRYPTXML.dll".}
pragma(lib, "cryptxml");
extern(Windows)
int CryptXmlDigestReference(
    void* hReference,   // void*
    uint dwFlags,   // DWORD
    CRYPT_XML_DATA_PROVIDER* pDataProviderIn   // CRYPT_XML_DATA_PROVIDER*
);
ccall((:CryptXmlDigestReference, "CRYPTXML.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, Ptr{CRYPT_XML_DATA_PROVIDER}),
      hReference, dwFlags, pDataProviderIn)
# hReference : void* -> Ptr{Cvoid}
# dwFlags : DWORD -> UInt32
# pDataProviderIn : CRYPT_XML_DATA_PROVIDER* -> Ptr{CRYPT_XML_DATA_PROVIDER}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t CryptXmlDigestReference(
    void* hReference,
    uint32_t dwFlags,
    void* pDataProviderIn);
]]
local cryptxml = ffi.load("cryptxml")
-- cryptxml.CryptXmlDigestReference(hReference, dwFlags, pDataProviderIn)
-- hReference : void*
-- dwFlags : DWORD
-- pDataProviderIn : CRYPT_XML_DATA_PROVIDER*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('CRYPTXML.dll');
const CryptXmlDigestReference = lib.func('__stdcall', 'CryptXmlDigestReference', 'int32_t', ['void *', 'uint32_t', 'void *']);
// CryptXmlDigestReference(hReference, dwFlags, pDataProviderIn)
// hReference : void* -> 'void *'
// dwFlags : DWORD -> 'uint32_t'
// pDataProviderIn : CRYPT_XML_DATA_PROVIDER* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("CRYPTXML.dll", {
  CryptXmlDigestReference: { parameters: ["pointer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.CryptXmlDigestReference(hReference, dwFlags, pDataProviderIn)
// hReference : void* -> "pointer"
// dwFlags : DWORD -> "u32"
// pDataProviderIn : CRYPT_XML_DATA_PROVIDER* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CryptXmlDigestReference(
    void* hReference,
    uint32_t dwFlags,
    void* pDataProviderIn);
C, "CRYPTXML.dll");
// $ffi->CryptXmlDigestReference(hReference, dwFlags, pDataProviderIn);
// hReference : void*
// dwFlags : DWORD
// pDataProviderIn : CRYPT_XML_DATA_PROVIDER*
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Cryptxml extends StdCallLibrary {
    Cryptxml INSTANCE = Native.load("cryptxml", Cryptxml.class);
    int CryptXmlDigestReference(
        Pointer hReference,   // void*
        int dwFlags,   // DWORD
        Pointer pDataProviderIn   // CRYPT_XML_DATA_PROVIDER*
    );
}
@[Link("cryptxml")]
lib LibCRYPTXML
  fun CryptXmlDigestReference = CryptXmlDigestReference(
    hReference : Void*,   # void*
    dwFlags : UInt32,   # DWORD
    pDataProviderIn : CRYPT_XML_DATA_PROVIDER*   # CRYPT_XML_DATA_PROVIDER*
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CryptXmlDigestReferenceNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Void>);
typedef CryptXmlDigestReferenceDart = int Function(Pointer<Void>, int, Pointer<Void>);
final CryptXmlDigestReference = DynamicLibrary.open('CRYPTXML.dll')
    .lookupFunction<CryptXmlDigestReferenceNative, CryptXmlDigestReferenceDart>('CryptXmlDigestReference');
// hReference : void* -> Pointer<Void>
// dwFlags : DWORD -> Uint32
// pDataProviderIn : CRYPT_XML_DATA_PROVIDER* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CryptXmlDigestReference(
  hReference: Pointer;   // void*
  dwFlags: DWORD;   // DWORD
  pDataProviderIn: Pointer   // CRYPT_XML_DATA_PROVIDER*
): Integer; stdcall;
  external 'CRYPTXML.dll' name 'CryptXmlDigestReference';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CryptXmlDigestReference"
  c_CryptXmlDigestReference :: Ptr () -> Word32 -> Ptr () -> IO Int32
-- hReference : void* -> Ptr ()
-- dwFlags : DWORD -> Word32
-- pDataProviderIn : CRYPT_XML_DATA_PROVIDER* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let cryptxmldigestreference =
  foreign "CryptXmlDigestReference"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* hReference : void* -> (ptr void) *)
(* dwFlags : DWORD -> uint32_t *)
(* pDataProviderIn : CRYPT_XML_DATA_PROVIDER* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library cryptxml (t "CRYPTXML.dll"))
(cffi:use-foreign-library cryptxml)

(cffi:defcfun ("CryptXmlDigestReference" crypt-xml-digest-reference :convention :stdcall) :int32
  (h-reference :pointer)   ; void*
  (dw-flags :uint32)   ; DWORD
  (p-data-provider-in :pointer))   ; CRYPT_XML_DATA_PROVIDER*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CryptXmlDigestReference = Win32::API::More->new('CRYPTXML',
    'int CryptXmlDigestReference(LPVOID hReference, DWORD dwFlags, LPVOID pDataProviderIn)');
# my $ret = $CryptXmlDigestReference->Call($hReference, $dwFlags, $pDataProviderIn);
# hReference : void* -> LPVOID
# dwFlags : DWORD -> DWORD
# pDataProviderIn : CRYPT_XML_DATA_PROVIDER* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型