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

NCryptExportKey

関数
キーを指定したBLOB形式でエクスポートする。
DLLncrypt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT NCryptExportKey(
    NCRYPT_KEY_HANDLE hKey,
    NCRYPT_KEY_HANDLE hExportKey,   // optional
    LPCWSTR pszBlobType,
    BCryptBufferDesc* pParameterList,   // optional
    BYTE* pbOutput,   // optional
    DWORD cbOutput,
    DWORD* pcbResult,
    NCRYPT_FLAGS dwFlags
);

パラメーター

名前方向
hKeyNCRYPT_KEY_HANDLEin
hExportKeyNCRYPT_KEY_HANDLEinoptional
pszBlobTypeLPCWSTRin
pParameterListBCryptBufferDesc*inoptional
pbOutputBYTE*outoptional
cbOutputDWORDin
pcbResultDWORD*out
dwFlagsNCRYPT_FLAGSin

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT NCryptExportKey(
    NCRYPT_KEY_HANDLE hKey,
    NCRYPT_KEY_HANDLE hExportKey,   // optional
    LPCWSTR pszBlobType,
    BCryptBufferDesc* pParameterList,   // optional
    BYTE* pbOutput,   // optional
    DWORD cbOutput,
    DWORD* pcbResult,
    NCRYPT_FLAGS dwFlags
);
[DllImport("ncrypt.dll", ExactSpelling = true)]
static extern int NCryptExportKey(
    UIntPtr hKey,   // NCRYPT_KEY_HANDLE
    UIntPtr hExportKey,   // NCRYPT_KEY_HANDLE optional
    [MarshalAs(UnmanagedType.LPWStr)] string pszBlobType,   // LPCWSTR
    IntPtr pParameterList,   // BCryptBufferDesc* optional
    IntPtr pbOutput,   // BYTE* optional, out
    uint cbOutput,   // DWORD
    out uint pcbResult,   // DWORD* out
    uint dwFlags   // NCRYPT_FLAGS
);
<DllImport("ncrypt.dll", ExactSpelling:=True)>
Public Shared Function NCryptExportKey(
    hKey As UIntPtr,   ' NCRYPT_KEY_HANDLE
    hExportKey As UIntPtr,   ' NCRYPT_KEY_HANDLE optional
    <MarshalAs(UnmanagedType.LPWStr)> pszBlobType As String,   ' LPCWSTR
    pParameterList As IntPtr,   ' BCryptBufferDesc* optional
    pbOutput As IntPtr,   ' BYTE* optional, out
    cbOutput As UInteger,   ' DWORD
    <Out> ByRef pcbResult As UInteger,   ' DWORD* out
    dwFlags As UInteger   ' NCRYPT_FLAGS
) As Integer
End Function
' hKey : NCRYPT_KEY_HANDLE
' hExportKey : NCRYPT_KEY_HANDLE optional
' pszBlobType : LPCWSTR
' pParameterList : BCryptBufferDesc* optional
' pbOutput : BYTE* optional, out
' cbOutput : DWORD
' pcbResult : DWORD* out
' dwFlags : NCRYPT_FLAGS
Declare PtrSafe Function NCryptExportKey Lib "ncrypt" ( _
    ByVal hKey As LongPtr, _
    ByVal hExportKey As LongPtr, _
    ByVal pszBlobType As LongPtr, _
    ByVal pParameterList As LongPtr, _
    ByVal pbOutput As LongPtr, _
    ByVal cbOutput As Long, _
    ByRef pcbResult As Long, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

NCryptExportKey = ctypes.windll.ncrypt.NCryptExportKey
NCryptExportKey.restype = ctypes.c_int
NCryptExportKey.argtypes = [
    ctypes.c_size_t,  # hKey : NCRYPT_KEY_HANDLE
    ctypes.c_size_t,  # hExportKey : NCRYPT_KEY_HANDLE optional
    wintypes.LPCWSTR,  # pszBlobType : LPCWSTR
    ctypes.c_void_p,  # pParameterList : BCryptBufferDesc* optional
    ctypes.POINTER(ctypes.c_ubyte),  # pbOutput : BYTE* optional, out
    wintypes.DWORD,  # cbOutput : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbResult : DWORD* out
    wintypes.DWORD,  # dwFlags : NCRYPT_FLAGS
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ncrypt.dll')
NCryptExportKey = Fiddle::Function.new(
  lib['NCryptExportKey'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hKey : NCRYPT_KEY_HANDLE
    Fiddle::TYPE_UINTPTR_T,  # hExportKey : NCRYPT_KEY_HANDLE optional
    Fiddle::TYPE_VOIDP,  # pszBlobType : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pParameterList : BCryptBufferDesc* optional
    Fiddle::TYPE_VOIDP,  # pbOutput : BYTE* optional, out
    -Fiddle::TYPE_INT,  # cbOutput : DWORD
    Fiddle::TYPE_VOIDP,  # pcbResult : DWORD* out
    -Fiddle::TYPE_INT,  # dwFlags : NCRYPT_FLAGS
  ],
  Fiddle::TYPE_INT)
#[link(name = "ncrypt")]
extern "system" {
    fn NCryptExportKey(
        hKey: usize,  // NCRYPT_KEY_HANDLE
        hExportKey: usize,  // NCRYPT_KEY_HANDLE optional
        pszBlobType: *const u16,  // LPCWSTR
        pParameterList: *mut BCryptBufferDesc,  // BCryptBufferDesc* optional
        pbOutput: *mut u8,  // BYTE* optional, out
        cbOutput: u32,  // DWORD
        pcbResult: *mut u32,  // DWORD* out
        dwFlags: u32  // NCRYPT_FLAGS
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ncrypt.dll")]
public static extern int NCryptExportKey(UIntPtr hKey, UIntPtr hExportKey, [MarshalAs(UnmanagedType.LPWStr)] string pszBlobType, IntPtr pParameterList, IntPtr pbOutput, uint cbOutput, out uint pcbResult, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ncrypt_NCryptExportKey' -Namespace Win32 -PassThru
# $api::NCryptExportKey(hKey, hExportKey, pszBlobType, pParameterList, pbOutput, cbOutput, pcbResult, dwFlags)
#uselib "ncrypt.dll"
#func global NCryptExportKey "NCryptExportKey" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; NCryptExportKey hKey, hExportKey, pszBlobType, varptr(pParameterList), varptr(pbOutput), cbOutput, varptr(pcbResult), dwFlags   ; 戻り値は stat
; hKey : NCRYPT_KEY_HANDLE -> "sptr"
; hExportKey : NCRYPT_KEY_HANDLE optional -> "sptr"
; pszBlobType : LPCWSTR -> "sptr"
; pParameterList : BCryptBufferDesc* optional -> "sptr"
; pbOutput : BYTE* optional, out -> "sptr"
; cbOutput : DWORD -> "sptr"
; pcbResult : DWORD* out -> "sptr"
; dwFlags : NCRYPT_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ncrypt.dll"
#cfunc global NCryptExportKey "NCryptExportKey" sptr, sptr, wstr, var, var, int, var, int
; res = NCryptExportKey(hKey, hExportKey, pszBlobType, pParameterList, pbOutput, cbOutput, pcbResult, dwFlags)
; hKey : NCRYPT_KEY_HANDLE -> "sptr"
; hExportKey : NCRYPT_KEY_HANDLE optional -> "sptr"
; pszBlobType : LPCWSTR -> "wstr"
; pParameterList : BCryptBufferDesc* optional -> "var"
; pbOutput : BYTE* optional, out -> "var"
; cbOutput : DWORD -> "int"
; pcbResult : DWORD* out -> "var"
; dwFlags : NCRYPT_FLAGS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT NCryptExportKey(NCRYPT_KEY_HANDLE hKey, NCRYPT_KEY_HANDLE hExportKey, LPCWSTR pszBlobType, BCryptBufferDesc* pParameterList, BYTE* pbOutput, DWORD cbOutput, DWORD* pcbResult, NCRYPT_FLAGS dwFlags)
#uselib "ncrypt.dll"
#cfunc global NCryptExportKey "NCryptExportKey" intptr, intptr, wstr, var, var, int, var, int
; res = NCryptExportKey(hKey, hExportKey, pszBlobType, pParameterList, pbOutput, cbOutput, pcbResult, dwFlags)
; hKey : NCRYPT_KEY_HANDLE -> "intptr"
; hExportKey : NCRYPT_KEY_HANDLE optional -> "intptr"
; pszBlobType : LPCWSTR -> "wstr"
; pParameterList : BCryptBufferDesc* optional -> "var"
; pbOutput : BYTE* optional, out -> "var"
; cbOutput : DWORD -> "int"
; pcbResult : DWORD* out -> "var"
; dwFlags : NCRYPT_FLAGS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ncrypt = windows.NewLazySystemDLL("ncrypt.dll")
	procNCryptExportKey = ncrypt.NewProc("NCryptExportKey")
)

// hKey (NCRYPT_KEY_HANDLE), hExportKey (NCRYPT_KEY_HANDLE optional), pszBlobType (LPCWSTR), pParameterList (BCryptBufferDesc* optional), pbOutput (BYTE* optional, out), cbOutput (DWORD), pcbResult (DWORD* out), dwFlags (NCRYPT_FLAGS)
r1, _, err := procNCryptExportKey.Call(
	uintptr(hKey),
	uintptr(hExportKey),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszBlobType))),
	uintptr(pParameterList),
	uintptr(pbOutput),
	uintptr(cbOutput),
	uintptr(pcbResult),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function NCryptExportKey(
  hKey: NativeUInt;   // NCRYPT_KEY_HANDLE
  hExportKey: NativeUInt;   // NCRYPT_KEY_HANDLE optional
  pszBlobType: PWideChar;   // LPCWSTR
  pParameterList: Pointer;   // BCryptBufferDesc* optional
  pbOutput: Pointer;   // BYTE* optional, out
  cbOutput: DWORD;   // DWORD
  pcbResult: Pointer;   // DWORD* out
  dwFlags: DWORD   // NCRYPT_FLAGS
): Integer; stdcall;
  external 'ncrypt.dll' name 'NCryptExportKey';
result := DllCall("ncrypt\NCryptExportKey"
    , "UPtr", hKey   ; NCRYPT_KEY_HANDLE
    , "UPtr", hExportKey   ; NCRYPT_KEY_HANDLE optional
    , "WStr", pszBlobType   ; LPCWSTR
    , "Ptr", pParameterList   ; BCryptBufferDesc* optional
    , "Ptr", pbOutput   ; BYTE* optional, out
    , "UInt", cbOutput   ; DWORD
    , "Ptr", pcbResult   ; DWORD* out
    , "UInt", dwFlags   ; NCRYPT_FLAGS
    , "Int")   ; return: HRESULT
●NCryptExportKey(hKey, hExportKey, pszBlobType, pParameterList, pbOutput, cbOutput, pcbResult, dwFlags) = DLL("ncrypt.dll", "int NCryptExportKey(int, int, char*, void*, void*, dword, void*, dword)")
# 呼び出し: NCryptExportKey(hKey, hExportKey, pszBlobType, pParameterList, pbOutput, cbOutput, pcbResult, dwFlags)
# hKey : NCRYPT_KEY_HANDLE -> "int"
# hExportKey : NCRYPT_KEY_HANDLE optional -> "int"
# pszBlobType : LPCWSTR -> "char*"
# pParameterList : BCryptBufferDesc* optional -> "void*"
# pbOutput : BYTE* optional, out -> "void*"
# cbOutput : DWORD -> "dword"
# pcbResult : DWORD* out -> "void*"
# dwFlags : NCRYPT_FLAGS -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。