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

NCryptOpenStorageProvider

関数
指定したCNGキーストレージプロバイダーを開く。
DLLncrypt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT NCryptOpenStorageProvider(
    NCRYPT_PROV_HANDLE* phProvider,
    LPCWSTR pszProviderName,   // optional
    DWORD dwFlags
);

パラメーター

名前方向説明
phProviderNCRYPT_PROV_HANDLE*outプロバイダー ハンドルを受け取る NCRYPT_PROV_HANDLE 変数へのポインターです。このハンドルの使用を終えたら、NCryptFreeObject 関数に渡して解放してください。
pszProviderNameLPCWSTRinoptional

読み込むキー ストレージ プロバイダーを識別する、null で終わる Unicode 文字列へのポインターです。これはキー ストレージ プロバイダーの登録済みエイリアスです。このパラメーターは省略可能で、NULL を指定できます。このパラメーターが NULL の場合、既定のキー ストレージ プロバイダーが読み込まれます。次の値は組み込みのキー ストレージ プロバイダーを識別します。

意味
MS_KEY_STORAGE_PROVIDER
L"Microsoft Software Key Storage Provider"
Microsoft が提供するソフトウェア キー ストレージ プロバイダーを識別します。
MS_SMART_CARD_KEY_STORAGE_PROVIDER
L"Microsoft Smart Card Key Storage Provider"
Microsoft が提供するスマート カード キー ストレージ プロバイダーを識別します。
MS_PLATFORM_CRYPTO_PROVIDER
L"Microsoft Platform Crypto Provider"
Microsoft が提供する TPM キー ストレージ プロバイダーを識別します。
dwFlagsDWORDin関数の動作を変更するフラグです。この関数に対して定義されているフラグはありません。

戻り値の型: HRESULT

公式ドキュメント

CNG キー ストレージ プロバイダーを読み込んで初期化します。

戻り値

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

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

戻り値 説明
ERROR_SUCCESS
関数は成功しました。
NTE_BAD_FLAGS
dwFlags パラメーターに、サポートされていない 1 つ以上のフラグが含まれています。
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 NCryptOpenStorageProvider(
    NCRYPT_PROV_HANDLE* phProvider,
    LPCWSTR pszProviderName,   // optional
    DWORD dwFlags
);
[DllImport("ncrypt.dll", ExactSpelling = true)]
static extern int NCryptOpenStorageProvider(
    out UIntPtr phProvider,   // NCRYPT_PROV_HANDLE* out
    [MarshalAs(UnmanagedType.LPWStr)] string pszProviderName,   // LPCWSTR optional
    uint dwFlags   // DWORD
);
<DllImport("ncrypt.dll", ExactSpelling:=True)>
Public Shared Function NCryptOpenStorageProvider(
    <Out> ByRef phProvider As UIntPtr,   ' NCRYPT_PROV_HANDLE* out
    <MarshalAs(UnmanagedType.LPWStr)> pszProviderName As String,   ' LPCWSTR optional
    dwFlags As UInteger   ' DWORD
) As Integer
End Function
' phProvider : NCRYPT_PROV_HANDLE* out
' pszProviderName : LPCWSTR optional
' dwFlags : DWORD
Declare PtrSafe Function NCryptOpenStorageProvider Lib "ncrypt" ( _
    ByRef phProvider As LongPtr, _
    ByVal pszProviderName 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

NCryptOpenStorageProvider = ctypes.windll.ncrypt.NCryptOpenStorageProvider
NCryptOpenStorageProvider.restype = ctypes.c_int
NCryptOpenStorageProvider.argtypes = [
    ctypes.c_void_p,  # phProvider : NCRYPT_PROV_HANDLE* out
    wintypes.LPCWSTR,  # pszProviderName : LPCWSTR optional
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ncrypt = windows.NewLazySystemDLL("ncrypt.dll")
	procNCryptOpenStorageProvider = ncrypt.NewProc("NCryptOpenStorageProvider")
)

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

extern "ncrypt" fn NCryptOpenStorageProvider(
    phProvider: [*c]usize, // NCRYPT_PROV_HANDLE* out
    pszProviderName: [*c]const u16, // LPCWSTR optional
    dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc NCryptOpenStorageProvider(
    phProvider: ptr uint,  # NCRYPT_PROV_HANDLE* out
    pszProviderName: WideCString,  # LPCWSTR optional
    dwFlags: uint32  # DWORD
): int32 {.importc: "NCryptOpenStorageProvider", stdcall, dynlib: "ncrypt.dll".}
pragma(lib, "ncrypt");
extern(Windows)
int NCryptOpenStorageProvider(
    size_t* phProvider,   // NCRYPT_PROV_HANDLE* out
    const(wchar)* pszProviderName,   // LPCWSTR optional
    uint dwFlags   // DWORD
);
ccall((:NCryptOpenStorageProvider, "ncrypt.dll"), stdcall, Int32,
      (Ptr{Csize_t}, Cwstring, UInt32),
      phProvider, pszProviderName, dwFlags)
# phProvider : NCRYPT_PROV_HANDLE* out -> Ptr{Csize_t}
# pszProviderName : LPCWSTR optional -> Cwstring
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t NCryptOpenStorageProvider(
    uintptr_t* phProvider,
    const uint16_t* pszProviderName,
    uint32_t dwFlags);
]]
local ncrypt = ffi.load("ncrypt")
-- ncrypt.NCryptOpenStorageProvider(phProvider, pszProviderName, dwFlags)
-- phProvider : NCRYPT_PROV_HANDLE* out
-- pszProviderName : LPCWSTR optional
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ncrypt.dll');
const NCryptOpenStorageProvider = lib.func('__stdcall', 'NCryptOpenStorageProvider', 'int32_t', ['uintptr_t *', 'str16', 'uint32_t']);
// NCryptOpenStorageProvider(phProvider, pszProviderName, dwFlags)
// phProvider : NCRYPT_PROV_HANDLE* out -> 'uintptr_t *'
// pszProviderName : LPCWSTR optional -> 'str16'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ncrypt.dll", {
  NCryptOpenStorageProvider: { parameters: ["pointer", "buffer", "u32"], result: "i32" },
});
// lib.symbols.NCryptOpenStorageProvider(phProvider, pszProviderName, dwFlags)
// phProvider : NCRYPT_PROV_HANDLE* out -> "pointer"
// pszProviderName : LPCWSTR optional -> "buffer"
// dwFlags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t NCryptOpenStorageProvider(
    size_t* phProvider,
    const uint16_t* pszProviderName,
    uint32_t dwFlags);
C, "ncrypt.dll");
// $ffi->NCryptOpenStorageProvider(phProvider, pszProviderName, dwFlags);
// phProvider : NCRYPT_PROV_HANDLE* out
// pszProviderName : LPCWSTR optional
// dwFlags : DWORD
// 構造体/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 NCryptOpenStorageProvider(
        LongByReference phProvider,   // NCRYPT_PROV_HANDLE* out
        WString pszProviderName,   // LPCWSTR optional
        int dwFlags   // DWORD
    );
}
@[Link("ncrypt")]
lib Libncrypt
  fun NCryptOpenStorageProvider = NCryptOpenStorageProvider(
    phProvider : LibC::SizeT*,   # NCRYPT_PROV_HANDLE* out
    pszProviderName : UInt16*,   # LPCWSTR optional
    dwFlags : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef NCryptOpenStorageProviderNative = Int32 Function(Pointer<UintPtr>, Pointer<Utf16>, Uint32);
typedef NCryptOpenStorageProviderDart = int Function(Pointer<UintPtr>, Pointer<Utf16>, int);
final NCryptOpenStorageProvider = DynamicLibrary.open('ncrypt.dll')
    .lookupFunction<NCryptOpenStorageProviderNative, NCryptOpenStorageProviderDart>('NCryptOpenStorageProvider');
// phProvider : NCRYPT_PROV_HANDLE* out -> Pointer<UintPtr>
// pszProviderName : LPCWSTR optional -> Pointer<Utf16>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function NCryptOpenStorageProvider(
  phProvider: Pointer;   // NCRYPT_PROV_HANDLE* out
  pszProviderName: PWideChar;   // LPCWSTR optional
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'ncrypt.dll' name 'NCryptOpenStorageProvider';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "NCryptOpenStorageProvider"
  c_NCryptOpenStorageProvider :: Ptr CUIntPtr -> CWString -> Word32 -> IO Int32
-- phProvider : NCRYPT_PROV_HANDLE* out -> Ptr CUIntPtr
-- pszProviderName : LPCWSTR optional -> CWString
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ncryptopenstorageprovider =
  foreign "NCryptOpenStorageProvider"
    ((ptr size_t) @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* phProvider : NCRYPT_PROV_HANDLE* out -> (ptr size_t) *)
(* pszProviderName : LPCWSTR optional -> (ptr uint16_t) *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ncrypt (t "ncrypt.dll"))
(cffi:use-foreign-library ncrypt)

(cffi:defcfun ("NCryptOpenStorageProvider" ncrypt-open-storage-provider :convention :stdcall) :int32
  (ph-provider :pointer)   ; NCRYPT_PROV_HANDLE* out
  (psz-provider-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NCryptOpenStorageProvider = Win32::API::More->new('ncrypt',
    'int NCryptOpenStorageProvider(LPVOID phProvider, LPCWSTR pszProviderName, DWORD dwFlags)');
# my $ret = $NCryptOpenStorageProvider->Call($phProvider, $pszProviderName, $dwFlags);
# phProvider : NCRYPT_PROV_HANDLE* out -> LPVOID
# pszProviderName : LPCWSTR optional -> LPCWSTR
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。