ホーム › Security.Cryptography › NCryptEnumStorageProviders

NCryptEnumStorageProviders

関数

システムに登録されたキーストレージプロバイダーを列挙する。

DLLncrypt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT NCryptEnumStorageProviders(
    DWORD* pdwProviderCount,
    NCryptProviderName** ppProviderList,
    DWORD dwFlags
);

パラメーター

名前

型

方向

説明

pdwProviderCount

DWORD*

out

ppProviderList 配列の要素数を受け取る DWORD のアドレスです。

ppProviderList

NCryptProviderName**

out

登録されているキーストレージプロバイダー名の配列を受け取る NCryptProviderName 構造体ポインターのアドレスです。pdwProviderCount パラメーターが指す変数には、この配列の要素数が格納されます。

このメモリが不要になったら、このポインターを NCryptFreeBuffer 関数に渡して解放してください。

dwFlags

DWORD

関数の動作を変更するフラグです。0 または次の値を指定できます。

値	意味
NCRYPT_SILENT_FLAG	キーストレージプロバイダー (KSP) がユーザーインターフェイスを表示しないように要求します。プロバイダーが動作のために UI を表示する必要がある場合、呼び出しは失敗し、KSP は最後のエラーとして NTE_SILENT_CONTEXT エラーコードを設定します。

戻り値の型: HRESULT

公式ドキュメント

登録されているキーストレージプロバイダーの名前を取得します。

戻り値

関数の成功または失敗を示すステータスコードを返します。

返される可能性があるコードには、次のものが含まれますが、これらに限定されません。

戻り値	説明
ERROR_SUCCESS	関数は成功しました。
NTE_BAD_FLAGS	dwFlags パラメーターに無効な値が含まれています。
NTE_INVALID_PARAMETER	1 つ以上のパラメーターが無効です。
NTE_NO_MEMORY	メモリの割り当てに失敗しました。

解説(Remarks)

サービスは、この関数を StartService 関数から呼び出してはなりません。サービスが StartService 関数からこの関数を呼び出すと、デッドロックが発生し、サービスが応答を停止する可能性があります。

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

各言語での呼び出し定義

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

HRESULT NCryptEnumStorageProviders(
    DWORD* pdwProviderCount,
    NCryptProviderName** ppProviderList,
    DWORD dwFlags
);

[DllImport("ncrypt.dll", ExactSpelling = true)]
static extern int NCryptEnumStorageProviders(
    out uint pdwProviderCount,   // DWORD* out
    IntPtr ppProviderList,   // NCryptProviderName** out
    uint dwFlags   // DWORD
);

<DllImport("ncrypt.dll", ExactSpelling:=True)>
Public Shared Function NCryptEnumStorageProviders(
    <Out> ByRef pdwProviderCount As UInteger,   ' DWORD* out
    ppProviderList As IntPtr,   ' NCryptProviderName** out
    dwFlags As UInteger   ' DWORD
) As Integer
End Function

' pdwProviderCount : DWORD* out
' ppProviderList : NCryptProviderName** out
' dwFlags : DWORD
Declare PtrSafe Function NCryptEnumStorageProviders Lib "ncrypt" ( _
    ByRef pdwProviderCount As Long, _
    ByVal ppProviderList 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

NCryptEnumStorageProviders = ctypes.windll.ncrypt.NCryptEnumStorageProviders
NCryptEnumStorageProviders.restype = ctypes.c_int
NCryptEnumStorageProviders.argtypes = [
    ctypes.POINTER(wintypes.DWORD),  # pdwProviderCount : DWORD* out
    ctypes.c_void_p,  # ppProviderList : NCryptProviderName** out
    wintypes.DWORD,  # dwFlags : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ncrypt.dll')
NCryptEnumStorageProviders = Fiddle::Function.new(
  lib['NCryptEnumStorageProviders'],
  [
    Fiddle::TYPE_VOIDP,  # pdwProviderCount : DWORD* out
    Fiddle::TYPE_VOIDP,  # ppProviderList : NCryptProviderName** out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "ncrypt")]
extern "system" {
    fn NCryptEnumStorageProviders(
        pdwProviderCount: *mut u32,  // DWORD* out
        ppProviderList: *mut *mut NCryptProviderName,  // NCryptProviderName** out
        dwFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ncrypt.dll")]
public static extern int NCryptEnumStorageProviders(out uint pdwProviderCount, IntPtr ppProviderList, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ncrypt_NCryptEnumStorageProviders' -Namespace Win32 -PassThru
# $api::NCryptEnumStorageProviders(pdwProviderCount, ppProviderList, dwFlags)

#uselib "ncrypt.dll"
#func global NCryptEnumStorageProviders "NCryptEnumStorageProviders" sptr, sptr, sptr
; NCryptEnumStorageProviders varptr(pdwProviderCount), varptr(ppProviderList), dwFlags   ; 戻り値は stat
; pdwProviderCount : DWORD* out -> "sptr"
; ppProviderList : NCryptProviderName** out -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ncrypt.dll"
#cfunc global NCryptEnumStorageProviders "NCryptEnumStorageProviders" var, var, int
; res = NCryptEnumStorageProviders(pdwProviderCount, ppProviderList, dwFlags)
; pdwProviderCount : DWORD* out -> "var"
; ppProviderList : NCryptProviderName** out -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ncrypt.dll"
#cfunc global NCryptEnumStorageProviders "NCryptEnumStorageProviders" sptr, sptr, int
; res = NCryptEnumStorageProviders(varptr(pdwProviderCount), varptr(ppProviderList), dwFlags)
; pdwProviderCount : DWORD* out -> "sptr"
; ppProviderList : NCryptProviderName** out -> "sptr"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。