NCryptEnumKeys
関数シグネチャ
// ncrypt.dll
#include <windows.h>
HRESULT NCryptEnumKeys(
NCRYPT_PROV_HANDLE hProvider,
LPCWSTR pszScope, // optional
NCryptKeyName** ppKeyName,
void** ppEnumState,
NCRYPT_FLAGS dwFlags
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|---|
| hProvider | NCRYPT_PROV_HANDLE | in | キーを列挙する対象のキー ストレージ プロバイダーのハンドル。このハンドルは NCryptOpenStorageProvider 関数で取得します。 | ||||||
| pszScope | LPCWSTR | inoptional | このパラメーターは現在使用されておらず、NULL である必要があります。 | ||||||
| ppKeyName | NCryptKeyName** | out | 取得したキーの名前を受け取る NCryptKeyName 構造体へのポインターのアドレス。このメモリの使用が終わったら、NCryptFreeBuffer 関数を呼び出して解放してください。 | ||||||
| ppEnumState | void** | inout | この関数の後続の呼び出しで使用される列挙状態情報を受け取る VOID ポインターのアドレス。この情報はキー ストレージ プロバイダーにとってのみ意味を持ち、呼び出し元にとっては不透明です。キー ストレージ プロバイダーはこの情報を使用して、列挙における次の項目を判別します。このパラメーターが指す変数に NULL が格納されている場合、列挙は最初から開始されます。 このメモリが不要になったら、このポインターを NCryptFreeBuffer 関数に渡して解放する必要があります。 | ||||||
| dwFlags | NCRYPT_FLAGS | in | 関数の動作を変更するフラグ。ゼロ、または以下の値の 1 つ以上の組み合わせを指定できます。
|
戻り値の型: HRESULT
公式ドキュメント
プロバイダーによって格納されているキーの名前を取得します。
戻り値
関数の成功または失敗を示すステータス コードを返します。
返される可能性のあるコードには、以下のものが含まれますが、これらに限定されません。
| Return code | Description |
|---|---|
| 関数は成功しました。 | |
| dwFlags パラメーターに無効な値が含まれています。 | |
| hProvider パラメーターが無効です。 | |
| 1 つ以上のパラメーターが無効です。 | |
| メモリ割り当てに失敗しました。 | |
| 列挙の終端に達しました。 | |
| dwFlags パラメーターに NCRYPT_SILENT_FLAG フラグが含まれていますが、列挙対象のキーがユーザーの操作を必要としています。 |
解説(Remarks)
この関数は、呼び出されるたびに 1 つの項目のみを取得します。列挙の状態は ppEnumState パラメーターが指す変数に格納されるため、この関数の呼び出し間で保持する必要があります。プロバイダーによって格納されている最後のキーが取得されると、次にこの関数が呼び出されたときに NTE_NO_MORE_ITEMS が返されます。列挙を最初からやり直すには、ppEnumState パラメーターが指す変数を NULL に設定し、ppKeyName パラメーターが指すメモリが NULL でない場合はそれを解放してから、この関数を再度呼び出します。
サービスは、StartService 関数からこの関数を呼び出してはなりません。サービスが StartService 関数からこの関数を呼び出すと、デッドロックが発生し、サービスが応答を停止する可能性があります。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// 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 方式にも切替可。#uselib "ncrypt.dll" #cfunc global NCryptEnumKeys "NCryptEnumKeys" sptr, wstr, sptr, sptr, int ; res = NCryptEnumKeys(hProvider, pszScope, varptr(ppKeyName), ppEnumState, dwFlags) ; hProvider : NCRYPT_PROV_HANDLE -> "sptr" ; pszScope : LPCWSTR optional -> "wstr" ; ppKeyName : NCryptKeyName** out -> "sptr" ; ppEnumState : void** in/out -> "sptr" ; dwFlags : NCRYPT_FLAGS -> "int" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは 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 方式にも切替可。; HRESULT NCryptEnumKeys(NCRYPT_PROV_HANDLE hProvider, LPCWSTR pszScope, NCryptKeyName** ppKeyName, void** ppEnumState, NCRYPT_FLAGS dwFlags) #uselib "ncrypt.dll" #cfunc global NCryptEnumKeys "NCryptEnumKeys" intptr, wstr, intptr, intptr, int ; res = NCryptEnumKeys(hProvider, pszScope, varptr(ppKeyName), ppEnumState, dwFlags) ; hProvider : NCRYPT_PROV_HANDLE -> "intptr" ; pszScope : LPCWSTR optional -> "wstr" ; ppKeyName : NCryptKeyName** out -> "intptr" ; ppEnumState : void** in/out -> "intptr" ; dwFlags : NCRYPT_FLAGS -> "int" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは 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 // HRESULTfunction 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)。const std = @import("std");
extern "ncrypt" fn NCryptEnumKeys(
hProvider: usize, // NCRYPT_PROV_HANDLE
pszScope: [*c]const u16, // LPCWSTR optional
ppKeyName: [*c][*c]NCryptKeyName, // NCryptKeyName** out
ppEnumState: ?*anyopaque, // void** in/out
dwFlags: u32 // NCRYPT_FLAGS
) callconv(std.os.windows.WINAPI) i32;proc NCryptEnumKeys(
hProvider: uint, # NCRYPT_PROV_HANDLE
pszScope: WideCString, # LPCWSTR optional
ppKeyName: ptr NCryptKeyName, # NCryptKeyName** out
ppEnumState: pointer, # void** in/out
dwFlags: uint32 # NCRYPT_FLAGS
): int32 {.importc: "NCryptEnumKeys", stdcall, dynlib: "ncrypt.dll".}pragma(lib, "ncrypt");
extern(Windows)
int NCryptEnumKeys(
size_t hProvider, // NCRYPT_PROV_HANDLE
const(wchar)* pszScope, // LPCWSTR optional
NCryptKeyName** ppKeyName, // NCryptKeyName** out
void** ppEnumState, // void** in/out
uint dwFlags // NCRYPT_FLAGS
);ccall((:NCryptEnumKeys, "ncrypt.dll"), stdcall, Int32,
(Csize_t, Cwstring, Ptr{NCryptKeyName}, Ptr{Cvoid}, UInt32),
hProvider, pszScope, ppKeyName, ppEnumState, dwFlags)
# hProvider : NCRYPT_PROV_HANDLE -> Csize_t
# pszScope : LPCWSTR optional -> Cwstring
# ppKeyName : NCryptKeyName** out -> Ptr{NCryptKeyName}
# ppEnumState : void** in/out -> Ptr{Cvoid}
# dwFlags : NCRYPT_FLAGS -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t NCryptEnumKeys(
uintptr_t hProvider,
const uint16_t* pszScope,
void* ppKeyName,
void** ppEnumState,
uint32_t dwFlags);
]]
local ncrypt = ffi.load("ncrypt")
-- ncrypt.NCryptEnumKeys(hProvider, pszScope, ppKeyName, ppEnumState, dwFlags)
-- hProvider : NCRYPT_PROV_HANDLE
-- pszScope : LPCWSTR optional
-- ppKeyName : NCryptKeyName** out
-- ppEnumState : void** in/out
-- dwFlags : NCRYPT_FLAGS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('ncrypt.dll');
const NCryptEnumKeys = lib.func('__stdcall', 'NCryptEnumKeys', 'int32_t', ['uintptr_t', 'str16', 'void *', 'void *', 'uint32_t']);
// NCryptEnumKeys(hProvider, pszScope, ppKeyName, ppEnumState, dwFlags)
// hProvider : NCRYPT_PROV_HANDLE -> 'uintptr_t'
// pszScope : LPCWSTR optional -> 'str16'
// ppKeyName : NCryptKeyName** out -> 'void *'
// ppEnumState : void** in/out -> 'void *'
// dwFlags : NCRYPT_FLAGS -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("ncrypt.dll", {
NCryptEnumKeys: { parameters: ["usize", "buffer", "pointer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.NCryptEnumKeys(hProvider, pszScope, ppKeyName, ppEnumState, dwFlags)
// hProvider : NCRYPT_PROV_HANDLE -> "usize"
// pszScope : LPCWSTR optional -> "buffer"
// ppKeyName : NCryptKeyName** out -> "pointer"
// ppEnumState : void** in/out -> "pointer"
// dwFlags : NCRYPT_FLAGS -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t NCryptEnumKeys(
size_t hProvider,
const uint16_t* pszScope,
void* ppKeyName,
void** ppEnumState,
uint32_t dwFlags);
C, "ncrypt.dll");
// $ffi->NCryptEnumKeys(hProvider, pszScope, ppKeyName, ppEnumState, dwFlags);
// hProvider : NCRYPT_PROV_HANDLE
// pszScope : LPCWSTR optional
// ppKeyName : NCryptKeyName** out
// ppEnumState : void** in/out
// dwFlags : NCRYPT_FLAGS
// 構造体/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 Ncrypt extends StdCallLibrary {
Ncrypt INSTANCE = Native.load("ncrypt", Ncrypt.class);
int NCryptEnumKeys(
long hProvider, // NCRYPT_PROV_HANDLE
WString pszScope, // LPCWSTR optional
Pointer ppKeyName, // NCryptKeyName** out
Pointer ppEnumState, // void** in/out
int dwFlags // NCRYPT_FLAGS
);
}@[Link("ncrypt")]
lib Libncrypt
fun NCryptEnumKeys = NCryptEnumKeys(
hProvider : LibC::SizeT, # NCRYPT_PROV_HANDLE
pszScope : UInt16*, # LPCWSTR optional
ppKeyName : NCryptKeyName**, # NCryptKeyName** out
ppEnumState : Void**, # void** in/out
dwFlags : UInt32 # NCRYPT_FLAGS
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef NCryptEnumKeysNative = Int32 Function(UintPtr, Pointer<Utf16>, Pointer<Void>, Pointer<Void>, Uint32);
typedef NCryptEnumKeysDart = int Function(int, Pointer<Utf16>, Pointer<Void>, Pointer<Void>, int);
final NCryptEnumKeys = DynamicLibrary.open('ncrypt.dll')
.lookupFunction<NCryptEnumKeysNative, NCryptEnumKeysDart>('NCryptEnumKeys');
// hProvider : NCRYPT_PROV_HANDLE -> UintPtr
// pszScope : LPCWSTR optional -> Pointer<Utf16>
// ppKeyName : NCryptKeyName** out -> Pointer<Void>
// ppEnumState : void** in/out -> Pointer<Void>
// dwFlags : NCRYPT_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
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';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "NCryptEnumKeys"
c_NCryptEnumKeys :: CUIntPtr -> CWString -> Ptr () -> Ptr () -> Word32 -> IO Int32
-- hProvider : NCRYPT_PROV_HANDLE -> CUIntPtr
-- pszScope : LPCWSTR optional -> CWString
-- ppKeyName : NCryptKeyName** out -> Ptr ()
-- ppEnumState : void** in/out -> Ptr ()
-- dwFlags : NCRYPT_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let ncryptenumkeys =
foreign "NCryptEnumKeys"
(size_t @-> (ptr uint16_t) @-> (ptr void) @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* hProvider : NCRYPT_PROV_HANDLE -> size_t *)
(* pszScope : LPCWSTR optional -> (ptr uint16_t) *)
(* ppKeyName : NCryptKeyName** out -> (ptr void) *)
(* ppEnumState : void** in/out -> (ptr void) *)
(* dwFlags : NCRYPT_FLAGS -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library ncrypt (t "ncrypt.dll"))
(cffi:use-foreign-library ncrypt)
(cffi:defcfun ("NCryptEnumKeys" ncrypt-enum-keys :convention :stdcall) :int32
(h-provider :uint64) ; NCRYPT_PROV_HANDLE
(psz-scope (:string :encoding :utf-16le)) ; LPCWSTR optional
(pp-key-name :pointer) ; NCryptKeyName** out
(pp-enum-state :pointer) ; void** in/out
(dw-flags :uint32)) ; NCRYPT_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $NCryptEnumKeys = Win32::API::More->new('ncrypt',
'int NCryptEnumKeys(WPARAM hProvider, LPCWSTR pszScope, LPVOID ppKeyName, LPVOID ppEnumState, DWORD dwFlags)');
# my $ret = $NCryptEnumKeys->Call($hProvider, $pszScope, $ppKeyName, $ppEnumState, $dwFlags);
# hProvider : NCRYPT_PROV_HANDLE -> WPARAM
# pszScope : LPCWSTR optional -> LPCWSTR
# ppKeyName : NCryptKeyName** out -> LPVOID
# ppEnumState : void** in/out -> LPVOID
# dwFlags : NCRYPT_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。