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

CryptSetAsyncParam

関数
非同期ハンドルにパラメータを設定する。
DLLCRYPT32.dll呼出規約winapi

シグネチャ

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

BOOL CryptSetAsyncParam(
    HCRYPTASYNC hAsync,
    LPSTR pszParamOid,
    void* pvParam,   // optional
    PFN_CRYPT_ASYNC_PARAM_FREE_FUNC pfnFree
);

パラメーター

名前方向説明
hAsyncHCRYPTASYNCin非同期ハンドルです。
pszParamOidLPSTRinパラメーター ID です。
pvParamvoid*inoptionalパラメーター値です。
pfnFreePFN_CRYPT_ASYNC_PARAM_FREE_FUNCinパラメーターが解放されるときに呼び出されるコールバック関数です。

戻り値の型: BOOL

公式ドキュメント

CryptSetAsyncParam 関数 (wincrypt.h) は、非同期パラメーターを設定します。

戻り値

成功した場合は S_OK を返します。

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

各言語での呼び出し定義

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

BOOL CryptSetAsyncParam(
    HCRYPTASYNC hAsync,
    LPSTR pszParamOid,
    void* pvParam,   // optional
    PFN_CRYPT_ASYNC_PARAM_FREE_FUNC pfnFree
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", ExactSpelling = true)]
static extern bool CryptSetAsyncParam(
    IntPtr hAsync,   // HCRYPTASYNC
    [MarshalAs(UnmanagedType.LPStr)] string pszParamOid,   // LPSTR
    IntPtr pvParam,   // void* optional
    IntPtr pfnFree   // PFN_CRYPT_ASYNC_PARAM_FREE_FUNC
);
<DllImport("CRYPT32.dll", ExactSpelling:=True)>
Public Shared Function CryptSetAsyncParam(
    hAsync As IntPtr,   ' HCRYPTASYNC
    <MarshalAs(UnmanagedType.LPStr)> pszParamOid As String,   ' LPSTR
    pvParam As IntPtr,   ' void* optional
    pfnFree As IntPtr   ' PFN_CRYPT_ASYNC_PARAM_FREE_FUNC
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hAsync : HCRYPTASYNC
' pszParamOid : LPSTR
' pvParam : void* optional
' pfnFree : PFN_CRYPT_ASYNC_PARAM_FREE_FUNC
Declare PtrSafe Function CryptSetAsyncParam Lib "crypt32" ( _
    ByVal hAsync As LongPtr, _
    ByVal pszParamOid As String, _
    ByVal pvParam As LongPtr, _
    ByVal pfnFree As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CryptSetAsyncParam = ctypes.windll.crypt32.CryptSetAsyncParam
CryptSetAsyncParam.restype = wintypes.BOOL
CryptSetAsyncParam.argtypes = [
    ctypes.c_ssize_t,  # hAsync : HCRYPTASYNC
    wintypes.LPCSTR,  # pszParamOid : LPSTR
    ctypes.POINTER(None),  # pvParam : void* optional
    ctypes.c_void_p,  # pfnFree : PFN_CRYPT_ASYNC_PARAM_FREE_FUNC
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CryptSetAsyncParam = Fiddle::Function.new(
  lib['CryptSetAsyncParam'],
  [
    Fiddle::TYPE_INTPTR_T,  # hAsync : HCRYPTASYNC
    Fiddle::TYPE_VOIDP,  # pszParamOid : LPSTR
    Fiddle::TYPE_VOIDP,  # pvParam : void* optional
    Fiddle::TYPE_VOIDP,  # pfnFree : PFN_CRYPT_ASYNC_PARAM_FREE_FUNC
  ],
  Fiddle::TYPE_INT)
#[link(name = "crypt32")]
extern "system" {
    fn CryptSetAsyncParam(
        hAsync: isize,  // HCRYPTASYNC
        pszParamOid: *mut u8,  // LPSTR
        pvParam: *mut (),  // void* optional
        pfnFree: *const core::ffi::c_void  // PFN_CRYPT_ASYNC_PARAM_FREE_FUNC
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll")]
public static extern bool CryptSetAsyncParam(IntPtr hAsync, [MarshalAs(UnmanagedType.LPStr)] string pszParamOid, IntPtr pvParam, IntPtr pfnFree);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptSetAsyncParam' -Namespace Win32 -PassThru
# $api::CryptSetAsyncParam(hAsync, pszParamOid, pvParam, pfnFree)
#uselib "CRYPT32.dll"
#func global CryptSetAsyncParam "CryptSetAsyncParam" sptr, sptr, sptr, sptr
; CryptSetAsyncParam hAsync, pszParamOid, pvParam, pfnFree   ; 戻り値は stat
; hAsync : HCRYPTASYNC -> "sptr"
; pszParamOid : LPSTR -> "sptr"
; pvParam : void* optional -> "sptr"
; pfnFree : PFN_CRYPT_ASYNC_PARAM_FREE_FUNC -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "CRYPT32.dll"
#cfunc global CryptSetAsyncParam "CryptSetAsyncParam" sptr, str, sptr, sptr
; res = CryptSetAsyncParam(hAsync, pszParamOid, pvParam, pfnFree)
; hAsync : HCRYPTASYNC -> "sptr"
; pszParamOid : LPSTR -> "str"
; pvParam : void* optional -> "sptr"
; pfnFree : PFN_CRYPT_ASYNC_PARAM_FREE_FUNC -> "sptr"
; BOOL CryptSetAsyncParam(HCRYPTASYNC hAsync, LPSTR pszParamOid, void* pvParam, PFN_CRYPT_ASYNC_PARAM_FREE_FUNC pfnFree)
#uselib "CRYPT32.dll"
#cfunc global CryptSetAsyncParam "CryptSetAsyncParam" intptr, str, intptr, intptr
; res = CryptSetAsyncParam(hAsync, pszParamOid, pvParam, pfnFree)
; hAsync : HCRYPTASYNC -> "intptr"
; pszParamOid : LPSTR -> "str"
; pvParam : void* optional -> "intptr"
; pfnFree : PFN_CRYPT_ASYNC_PARAM_FREE_FUNC -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	crypt32 = windows.NewLazySystemDLL("CRYPT32.dll")
	procCryptSetAsyncParam = crypt32.NewProc("CryptSetAsyncParam")
)

// hAsync (HCRYPTASYNC), pszParamOid (LPSTR), pvParam (void* optional), pfnFree (PFN_CRYPT_ASYNC_PARAM_FREE_FUNC)
r1, _, err := procCryptSetAsyncParam.Call(
	uintptr(hAsync),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszParamOid))),
	uintptr(pvParam),
	uintptr(pfnFree),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function CryptSetAsyncParam(
  hAsync: NativeInt;   // HCRYPTASYNC
  pszParamOid: PAnsiChar;   // LPSTR
  pvParam: Pointer;   // void* optional
  pfnFree: Pointer   // PFN_CRYPT_ASYNC_PARAM_FREE_FUNC
): BOOL; stdcall;
  external 'CRYPT32.dll' name 'CryptSetAsyncParam';
result := DllCall("CRYPT32\CryptSetAsyncParam"
    , "Ptr", hAsync   ; HCRYPTASYNC
    , "AStr", pszParamOid   ; LPSTR
    , "Ptr", pvParam   ; void* optional
    , "Ptr", pfnFree   ; PFN_CRYPT_ASYNC_PARAM_FREE_FUNC
    , "Int")   ; return: BOOL
●CryptSetAsyncParam(hAsync, pszParamOid, pvParam, pfnFree) = DLL("CRYPT32.dll", "bool CryptSetAsyncParam(int, char*, void*, void*)")
# 呼び出し: CryptSetAsyncParam(hAsync, pszParamOid, pvParam, pfnFree)
# hAsync : HCRYPTASYNC -> "int"
# pszParamOid : LPSTR -> "char*"
# pvParam : void* optional -> "void*"
# pfnFree : PFN_CRYPT_ASYNC_PARAM_FREE_FUNC -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "crypt32" fn CryptSetAsyncParam(
    hAsync: isize, // HCRYPTASYNC
    pszParamOid: [*c]const u8, // LPSTR
    pvParam: ?*anyopaque, // void* optional
    pfnFree: ?*anyopaque // PFN_CRYPT_ASYNC_PARAM_FREE_FUNC
) callconv(std.os.windows.WINAPI) i32;
proc CryptSetAsyncParam(
    hAsync: int,  # HCRYPTASYNC
    pszParamOid: cstring,  # LPSTR
    pvParam: pointer,  # void* optional
    pfnFree: pointer  # PFN_CRYPT_ASYNC_PARAM_FREE_FUNC
): int32 {.importc: "CryptSetAsyncParam", stdcall, dynlib: "CRYPT32.dll".}
pragma(lib, "crypt32");
extern(Windows)
int CryptSetAsyncParam(
    ptrdiff_t hAsync,   // HCRYPTASYNC
    const(char)* pszParamOid,   // LPSTR
    void* pvParam,   // void* optional
    void* pfnFree   // PFN_CRYPT_ASYNC_PARAM_FREE_FUNC
);
ccall((:CryptSetAsyncParam, "CRYPT32.dll"), stdcall, Int32,
      (Int, Cstring, Ptr{Cvoid}, Ptr{Cvoid}),
      hAsync, pszParamOid, pvParam, pfnFree)
# hAsync : HCRYPTASYNC -> Int
# pszParamOid : LPSTR -> Cstring
# pvParam : void* optional -> Ptr{Cvoid}
# pfnFree : PFN_CRYPT_ASYNC_PARAM_FREE_FUNC -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t CryptSetAsyncParam(
    intptr_t hAsync,
    const char* pszParamOid,
    void* pvParam,
    void* pfnFree);
]]
local crypt32 = ffi.load("crypt32")
-- crypt32.CryptSetAsyncParam(hAsync, pszParamOid, pvParam, pfnFree)
-- hAsync : HCRYPTASYNC
-- pszParamOid : LPSTR
-- pvParam : void* optional
-- pfnFree : PFN_CRYPT_ASYNC_PARAM_FREE_FUNC
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('CRYPT32.dll');
const CryptSetAsyncParam = lib.func('__stdcall', 'CryptSetAsyncParam', 'int32_t', ['intptr_t', 'str', 'void *', 'void *']);
// CryptSetAsyncParam(hAsync, pszParamOid, pvParam, pfnFree)
// hAsync : HCRYPTASYNC -> 'intptr_t'
// pszParamOid : LPSTR -> 'str'
// pvParam : void* optional -> 'void *'
// pfnFree : PFN_CRYPT_ASYNC_PARAM_FREE_FUNC -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("CRYPT32.dll", {
  CryptSetAsyncParam: { parameters: ["isize", "buffer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.CryptSetAsyncParam(hAsync, pszParamOid, pvParam, pfnFree)
// hAsync : HCRYPTASYNC -> "isize"
// pszParamOid : LPSTR -> "buffer"
// pvParam : void* optional -> "pointer"
// pfnFree : PFN_CRYPT_ASYNC_PARAM_FREE_FUNC -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CryptSetAsyncParam(
    intptr_t hAsync,
    const char* pszParamOid,
    void* pvParam,
    void* pfnFree);
C, "CRYPT32.dll");
// $ffi->CryptSetAsyncParam(hAsync, pszParamOid, pvParam, pfnFree);
// hAsync : HCRYPTASYNC
// pszParamOid : LPSTR
// pvParam : void* optional
// pfnFree : PFN_CRYPT_ASYNC_PARAM_FREE_FUNC
// 構造体/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 Crypt32 extends StdCallLibrary {
    Crypt32 INSTANCE = Native.load("crypt32", Crypt32.class);
    boolean CryptSetAsyncParam(
        long hAsync,   // HCRYPTASYNC
        String pszParamOid,   // LPSTR
        Pointer pvParam,   // void* optional
        Callback pfnFree   // PFN_CRYPT_ASYNC_PARAM_FREE_FUNC
    );
}
@[Link("crypt32")]
lib LibCRYPT32
  fun CryptSetAsyncParam = CryptSetAsyncParam(
    hAsync : LibC::SSizeT,   # HCRYPTASYNC
    pszParamOid : UInt8*,   # LPSTR
    pvParam : Void*,   # void* optional
    pfnFree : Void*   # PFN_CRYPT_ASYNC_PARAM_FREE_FUNC
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CryptSetAsyncParamNative = Int32 Function(IntPtr, Pointer<Utf8>, Pointer<Void>, Pointer<Void>);
typedef CryptSetAsyncParamDart = int Function(int, Pointer<Utf8>, Pointer<Void>, Pointer<Void>);
final CryptSetAsyncParam = DynamicLibrary.open('CRYPT32.dll')
    .lookupFunction<CryptSetAsyncParamNative, CryptSetAsyncParamDart>('CryptSetAsyncParam');
// hAsync : HCRYPTASYNC -> IntPtr
// pszParamOid : LPSTR -> Pointer<Utf8>
// pvParam : void* optional -> Pointer<Void>
// pfnFree : PFN_CRYPT_ASYNC_PARAM_FREE_FUNC -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CryptSetAsyncParam(
  hAsync: NativeInt;   // HCRYPTASYNC
  pszParamOid: PAnsiChar;   // LPSTR
  pvParam: Pointer;   // void* optional
  pfnFree: Pointer   // PFN_CRYPT_ASYNC_PARAM_FREE_FUNC
): BOOL; stdcall;
  external 'CRYPT32.dll' name 'CryptSetAsyncParam';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CryptSetAsyncParam"
  c_CryptSetAsyncParam :: CIntPtr -> CString -> Ptr () -> Ptr () -> IO CInt
-- hAsync : HCRYPTASYNC -> CIntPtr
-- pszParamOid : LPSTR -> CString
-- pvParam : void* optional -> Ptr ()
-- pfnFree : PFN_CRYPT_ASYNC_PARAM_FREE_FUNC -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let cryptsetasyncparam =
  foreign "CryptSetAsyncParam"
    (intptr_t @-> string @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* hAsync : HCRYPTASYNC -> intptr_t *)
(* pszParamOid : LPSTR -> string *)
(* pvParam : void* optional -> (ptr void) *)
(* pfnFree : PFN_CRYPT_ASYNC_PARAM_FREE_FUNC -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library crypt32 (t "CRYPT32.dll"))
(cffi:use-foreign-library crypt32)

(cffi:defcfun ("CryptSetAsyncParam" crypt-set-async-param :convention :stdcall) :int32
  (h-async :int64)   ; HCRYPTASYNC
  (psz-param-oid :string)   ; LPSTR
  (pv-param :pointer)   ; void* optional
  (pfn-free :pointer))   ; PFN_CRYPT_ASYNC_PARAM_FREE_FUNC
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CryptSetAsyncParam = Win32::API::More->new('CRYPT32',
    'BOOL CryptSetAsyncParam(LPARAM hAsync, LPCSTR pszParamOid, LPVOID pvParam, LPVOID pfnFree)');
# my $ret = $CryptSetAsyncParam->Call($hAsync, $pszParamOid, $pvParam, $pfnFree);
# hAsync : HCRYPTASYNC -> LPARAM
# pszParamOid : LPSTR -> LPCSTR
# pvParam : void* optional -> LPVOID
# pfnFree : PFN_CRYPT_ASYNC_PARAM_FREE_FUNC -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

使用する型