ホーム › Security.Cryptography › NCryptIsAlgSupported
NCryptIsAlgSupported
関数指定アルゴリズムがプロバイダーでサポートされるか判定する。
シグネチャ
// ncrypt.dll
#include <windows.h>
HRESULT NCryptIsAlgSupported(
NCRYPT_PROV_HANDLE hProvider,
LPCWSTR pszAlgId,
DWORD dwFlags
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||
|---|---|---|---|---|---|---|---|
| hProvider | NCRYPT_PROV_HANDLE | in | キー ストレージ プロバイダーのハンドル。このハンドルは NCryptOpenStorageProvider 関数で取得します。 | ||||
| pszAlgId | LPCWSTR | in | 対象の暗号アルゴリズムを識別する、null で終わる Unicode 文字列へのポインター。標準の CNG Algorithm Identifiers のいずれか、または別の登録済みアルゴリズムの識別子を指定できます。 | ||||
| dwFlags | DWORD | in | 関数の動作を変更するフラグ。ゼロ (0) または次の値を指定できます。
|
戻り値の型: HRESULT
公式ドキュメント
CNG キー ストレージ プロバイダーが特定の暗号アルゴリズムをサポートしているかどうかを判定します。
戻り値
関数の成功または失敗を示すステータス コードを返します。
返される可能性のあるコードには、次のものが含まれます (これらに限定されません)。
| Return code | Description |
|---|---|
| プロバイダーは指定されたアルゴリズムをサポートしています。 | |
| dwFlags パラメーターに、サポートされていないフラグが 1 つ以上含まれています。 | |
| hProvider パラメーターで指定されたハンドルが無効です。 | |
| 1 つ以上のパラメーターが無効です。 | |
| プロバイダーは指定されたアルゴリズムをサポートしていません。 |
解説(Remarks)
プロバイダーがアルゴリズムをサポートしている場合、この関数は ERROR_SUCCESS を返します。プロバイダーがアルゴリズムをサポートしておらず、他のエラーも発生していない場合、この関数は NTE_NOT_SUPPORTED を返します。
サービスは、その StartService Function からこの関数を呼び出してはなりません。サービスが StartService 関数からこの関数を呼び出すと、デッドロックが発生し、サービスが応答しなくなる可能性があります。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// ncrypt.dll
#include <windows.h>
HRESULT NCryptIsAlgSupported(
NCRYPT_PROV_HANDLE hProvider,
LPCWSTR pszAlgId,
DWORD dwFlags
);[DllImport("ncrypt.dll", ExactSpelling = true)]
static extern int NCryptIsAlgSupported(
UIntPtr hProvider, // NCRYPT_PROV_HANDLE
[MarshalAs(UnmanagedType.LPWStr)] string pszAlgId, // LPCWSTR
uint dwFlags // DWORD
);<DllImport("ncrypt.dll", ExactSpelling:=True)>
Public Shared Function NCryptIsAlgSupported(
hProvider As UIntPtr, ' NCRYPT_PROV_HANDLE
<MarshalAs(UnmanagedType.LPWStr)> pszAlgId As String, ' LPCWSTR
dwFlags As UInteger ' DWORD
) As Integer
End Function' hProvider : NCRYPT_PROV_HANDLE
' pszAlgId : LPCWSTR
' dwFlags : DWORD
Declare PtrSafe Function NCryptIsAlgSupported Lib "ncrypt" ( _
ByVal hProvider As LongPtr, _
ByVal pszAlgId 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
NCryptIsAlgSupported = ctypes.windll.ncrypt.NCryptIsAlgSupported
NCryptIsAlgSupported.restype = ctypes.c_int
NCryptIsAlgSupported.argtypes = [
ctypes.c_size_t, # hProvider : NCRYPT_PROV_HANDLE
wintypes.LPCWSTR, # pszAlgId : LPCWSTR
wintypes.DWORD, # dwFlags : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('ncrypt.dll')
NCryptIsAlgSupported = Fiddle::Function.new(
lib['NCryptIsAlgSupported'],
[
Fiddle::TYPE_UINTPTR_T, # hProvider : NCRYPT_PROV_HANDLE
Fiddle::TYPE_VOIDP, # pszAlgId : LPCWSTR
-Fiddle::TYPE_INT, # dwFlags : DWORD
],
Fiddle::TYPE_INT)#[link(name = "ncrypt")]
extern "system" {
fn NCryptIsAlgSupported(
hProvider: usize, // NCRYPT_PROV_HANDLE
pszAlgId: *const u16, // LPCWSTR
dwFlags: u32 // DWORD
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("ncrypt.dll")]
public static extern int NCryptIsAlgSupported(UIntPtr hProvider, [MarshalAs(UnmanagedType.LPWStr)] string pszAlgId, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ncrypt_NCryptIsAlgSupported' -Namespace Win32 -PassThru
# $api::NCryptIsAlgSupported(hProvider, pszAlgId, dwFlags)#uselib "ncrypt.dll"
#func global NCryptIsAlgSupported "NCryptIsAlgSupported" sptr, sptr, sptr
; NCryptIsAlgSupported hProvider, pszAlgId, dwFlags ; 戻り値は stat
; hProvider : NCRYPT_PROV_HANDLE -> "sptr"
; pszAlgId : LPCWSTR -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "ncrypt.dll"
#cfunc global NCryptIsAlgSupported "NCryptIsAlgSupported" sptr, wstr, int
; res = NCryptIsAlgSupported(hProvider, pszAlgId, dwFlags)
; hProvider : NCRYPT_PROV_HANDLE -> "sptr"
; pszAlgId : LPCWSTR -> "wstr"
; dwFlags : DWORD -> "int"; HRESULT NCryptIsAlgSupported(NCRYPT_PROV_HANDLE hProvider, LPCWSTR pszAlgId, DWORD dwFlags)
#uselib "ncrypt.dll"
#cfunc global NCryptIsAlgSupported "NCryptIsAlgSupported" intptr, wstr, int
; res = NCryptIsAlgSupported(hProvider, pszAlgId, dwFlags)
; hProvider : NCRYPT_PROV_HANDLE -> "intptr"
; pszAlgId : LPCWSTR -> "wstr"
; dwFlags : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
ncrypt = windows.NewLazySystemDLL("ncrypt.dll")
procNCryptIsAlgSupported = ncrypt.NewProc("NCryptIsAlgSupported")
)
// hProvider (NCRYPT_PROV_HANDLE), pszAlgId (LPCWSTR), dwFlags (DWORD)
r1, _, err := procNCryptIsAlgSupported.Call(
uintptr(hProvider),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszAlgId))),
uintptr(dwFlags),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction NCryptIsAlgSupported(
hProvider: NativeUInt; // NCRYPT_PROV_HANDLE
pszAlgId: PWideChar; // LPCWSTR
dwFlags: DWORD // DWORD
): Integer; stdcall;
external 'ncrypt.dll' name 'NCryptIsAlgSupported';result := DllCall("ncrypt\NCryptIsAlgSupported"
, "UPtr", hProvider ; NCRYPT_PROV_HANDLE
, "WStr", pszAlgId ; LPCWSTR
, "UInt", dwFlags ; DWORD
, "Int") ; return: HRESULT●NCryptIsAlgSupported(hProvider, pszAlgId, dwFlags) = DLL("ncrypt.dll", "int NCryptIsAlgSupported(int, char*, dword)")
# 呼び出し: NCryptIsAlgSupported(hProvider, pszAlgId, dwFlags)
# hProvider : NCRYPT_PROV_HANDLE -> "int"
# pszAlgId : LPCWSTR -> "char*"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "ncrypt" fn NCryptIsAlgSupported(
hProvider: usize, // NCRYPT_PROV_HANDLE
pszAlgId: [*c]const u16, // LPCWSTR
dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;proc NCryptIsAlgSupported(
hProvider: uint, # NCRYPT_PROV_HANDLE
pszAlgId: WideCString, # LPCWSTR
dwFlags: uint32 # DWORD
): int32 {.importc: "NCryptIsAlgSupported", stdcall, dynlib: "ncrypt.dll".}pragma(lib, "ncrypt");
extern(Windows)
int NCryptIsAlgSupported(
size_t hProvider, // NCRYPT_PROV_HANDLE
const(wchar)* pszAlgId, // LPCWSTR
uint dwFlags // DWORD
);ccall((:NCryptIsAlgSupported, "ncrypt.dll"), stdcall, Int32,
(Csize_t, Cwstring, UInt32),
hProvider, pszAlgId, dwFlags)
# hProvider : NCRYPT_PROV_HANDLE -> Csize_t
# pszAlgId : LPCWSTR -> Cwstring
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t NCryptIsAlgSupported(
uintptr_t hProvider,
const uint16_t* pszAlgId,
uint32_t dwFlags);
]]
local ncrypt = ffi.load("ncrypt")
-- ncrypt.NCryptIsAlgSupported(hProvider, pszAlgId, dwFlags)
-- hProvider : NCRYPT_PROV_HANDLE
-- pszAlgId : LPCWSTR
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('ncrypt.dll');
const NCryptIsAlgSupported = lib.func('__stdcall', 'NCryptIsAlgSupported', 'int32_t', ['uintptr_t', 'str16', 'uint32_t']);
// NCryptIsAlgSupported(hProvider, pszAlgId, dwFlags)
// hProvider : NCRYPT_PROV_HANDLE -> 'uintptr_t'
// pszAlgId : LPCWSTR -> 'str16'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("ncrypt.dll", {
NCryptIsAlgSupported: { parameters: ["usize", "buffer", "u32"], result: "i32" },
});
// lib.symbols.NCryptIsAlgSupported(hProvider, pszAlgId, dwFlags)
// hProvider : NCRYPT_PROV_HANDLE -> "usize"
// pszAlgId : LPCWSTR -> "buffer"
// dwFlags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t NCryptIsAlgSupported(
size_t hProvider,
const uint16_t* pszAlgId,
uint32_t dwFlags);
C, "ncrypt.dll");
// $ffi->NCryptIsAlgSupported(hProvider, pszAlgId, dwFlags);
// hProvider : NCRYPT_PROV_HANDLE
// pszAlgId : LPCWSTR
// 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 NCryptIsAlgSupported(
long hProvider, // NCRYPT_PROV_HANDLE
WString pszAlgId, // LPCWSTR
int dwFlags // DWORD
);
}@[Link("ncrypt")]
lib Libncrypt
fun NCryptIsAlgSupported = NCryptIsAlgSupported(
hProvider : LibC::SizeT, # NCRYPT_PROV_HANDLE
pszAlgId : UInt16*, # LPCWSTR
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 NCryptIsAlgSupportedNative = Int32 Function(UintPtr, Pointer<Utf16>, Uint32);
typedef NCryptIsAlgSupportedDart = int Function(int, Pointer<Utf16>, int);
final NCryptIsAlgSupported = DynamicLibrary.open('ncrypt.dll')
.lookupFunction<NCryptIsAlgSupportedNative, NCryptIsAlgSupportedDart>('NCryptIsAlgSupported');
// hProvider : NCRYPT_PROV_HANDLE -> UintPtr
// pszAlgId : LPCWSTR -> Pointer<Utf16>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function NCryptIsAlgSupported(
hProvider: NativeUInt; // NCRYPT_PROV_HANDLE
pszAlgId: PWideChar; // LPCWSTR
dwFlags: DWORD // DWORD
): Integer; stdcall;
external 'ncrypt.dll' name 'NCryptIsAlgSupported';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "NCryptIsAlgSupported"
c_NCryptIsAlgSupported :: CUIntPtr -> CWString -> Word32 -> IO Int32
-- hProvider : NCRYPT_PROV_HANDLE -> CUIntPtr
-- pszAlgId : LPCWSTR -> CWString
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let ncryptisalgsupported =
foreign "NCryptIsAlgSupported"
(size_t @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* hProvider : NCRYPT_PROV_HANDLE -> size_t *)
(* pszAlgId : LPCWSTR -> (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 ("NCryptIsAlgSupported" ncrypt-is-alg-supported :convention :stdcall) :int32
(h-provider :uint64) ; NCRYPT_PROV_HANDLE
(psz-alg-id (:string :encoding :utf-16le)) ; LPCWSTR
(dw-flags :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $NCryptIsAlgSupported = Win32::API::More->new('ncrypt',
'int NCryptIsAlgSupported(WPARAM hProvider, LPCWSTR pszAlgId, DWORD dwFlags)');
# my $ret = $NCryptIsAlgSupported->Call($hProvider, $pszAlgId, $dwFlags);
# hProvider : NCRYPT_PROV_HANDLE -> WPARAM
# pszAlgId : LPCWSTR -> LPCWSTR
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。