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

NCryptEnumKeys

関数
ストレージプロバイダー内の永続キーを列挙する。
DLLncrypt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT NCryptEnumKeys(
    NCRYPT_PROV_HANDLE hProvider,
    LPCWSTR pszScope,   // optional
    NCryptKeyName** ppKeyName,
    void** ppEnumState,
    NCRYPT_FLAGS dwFlags
);

パラメーター

名前方向
hProviderNCRYPT_PROV_HANDLEin
pszScopeLPCWSTRinoptional
ppKeyNameNCryptKeyName**out
ppEnumStatevoid**inout
dwFlagsNCRYPT_FLAGSin

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT NCryptEnumKeys(
    NCRYPT_PROV_HANDLE hProvider,
    LPCWSTR pszScope,   // optional
    NCryptKeyName** ppKeyName,
    void** ppEnumState,
    NCRYPT_FLAGS dwFlags
);
[DllImport("ncrypt.dll", ExactSpelling = true)]
static extern int NCryptEnumKeys(
    UIntPtr hProvider,   // NCRYPT_PROV_HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string pszScope,   // LPCWSTR optional
    IntPtr ppKeyName,   // NCryptKeyName** out
    IntPtr ppEnumState,   // void** in/out
    uint dwFlags   // NCRYPT_FLAGS
);
<DllImport("ncrypt.dll", ExactSpelling:=True)>
Public Shared Function NCryptEnumKeys(
    hProvider As UIntPtr,   ' NCRYPT_PROV_HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> pszScope As String,   ' LPCWSTR optional
    ppKeyName As IntPtr,   ' NCryptKeyName** out
    ppEnumState As IntPtr,   ' void** in/out
    dwFlags As UInteger   ' NCRYPT_FLAGS
) As Integer
End Function
' hProvider : NCRYPT_PROV_HANDLE
' pszScope : LPCWSTR optional
' ppKeyName : NCryptKeyName** out
' ppEnumState : void** in/out
' dwFlags : NCRYPT_FLAGS
Declare PtrSafe Function NCryptEnumKeys Lib "ncrypt" ( _
    ByVal hProvider As LongPtr, _
    ByVal pszScope As LongPtr, _
    ByVal ppKeyName As LongPtr, _
    ByVal ppEnumState As LongPtr, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

NCryptEnumKeys = ctypes.windll.ncrypt.NCryptEnumKeys
NCryptEnumKeys.restype = ctypes.c_int
NCryptEnumKeys.argtypes = [
    ctypes.c_size_t,  # hProvider : NCRYPT_PROV_HANDLE
    wintypes.LPCWSTR,  # pszScope : LPCWSTR optional
    ctypes.c_void_p,  # ppKeyName : NCryptKeyName** out
    ctypes.c_void_p,  # ppEnumState : void** in/out
    wintypes.DWORD,  # dwFlags : NCRYPT_FLAGS
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ncrypt = windows.NewLazySystemDLL("ncrypt.dll")
	procNCryptEnumKeys = ncrypt.NewProc("NCryptEnumKeys")
)

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