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

BCryptCloseAlgorithmProvider

関数
開いているCNGアルゴリズムプロバイダーを閉じる。
DLLbcrypt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

NTSTATUS BCryptCloseAlgorithmProvider(
    BCRYPT_ALG_HANDLE hAlgorithm,
    DWORD dwFlags
);

パラメーター

名前方向説明
hAlgorithmBCRYPT_ALG_HANDLEinout閉じるアルゴリズム プロバイダーを表すハンドル。このハンドルは、BCryptOpenAlgorithmProvider 関数を呼び出すことで取得します。
dwFlagsDWORDinこの関数の動作を変更する一連のフラグ。この関数に定義されているフラグはありません。

戻り値の型: NTSTATUS

公式ドキュメント

アルゴリズム プロバイダーを閉じます。

戻り値

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

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

戻り値 説明
STATUS_SUCCESS 関数は成功しました。
STATUS_INVALID_HANDLE hAlgorithm パラメーターで指定されたアルゴリズム ハンドルが無効であるか、閉じることのできない疑似ハンドルです。

解説(Remarks)

BCryptCloseAlgorithmProvider は、ユーザー モードまたはカーネル モードのいずれからでも呼び出すことができます。カーネル モードの呼び出し元は、PASSIVE_LEVEL IRQL で実行されている必要があります。

カーネル モードでこの関数を呼び出すには、Driver Development Kit (DDK) の一部である Cng.lib を使用します。Windows Server 2008 および Windows Vista: カーネル モードでこの関数を呼び出すには、Ksecdd.lib を使用します。

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

各言語での呼び出し定義

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

NTSTATUS BCryptCloseAlgorithmProvider(
    BCRYPT_ALG_HANDLE hAlgorithm,
    DWORD dwFlags
);
[DllImport("bcrypt.dll", ExactSpelling = true)]
static extern int BCryptCloseAlgorithmProvider(
    IntPtr hAlgorithm,   // BCRYPT_ALG_HANDLE in/out
    uint dwFlags   // DWORD
);
<DllImport("bcrypt.dll", ExactSpelling:=True)>
Public Shared Function BCryptCloseAlgorithmProvider(
    hAlgorithm As IntPtr,   ' BCRYPT_ALG_HANDLE in/out
    dwFlags As UInteger   ' DWORD
) As Integer
End Function
' hAlgorithm : BCRYPT_ALG_HANDLE in/out
' dwFlags : DWORD
Declare PtrSafe Function BCryptCloseAlgorithmProvider Lib "bcrypt" ( _
    ByVal hAlgorithm 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

BCryptCloseAlgorithmProvider = ctypes.windll.bcrypt.BCryptCloseAlgorithmProvider
BCryptCloseAlgorithmProvider.restype = ctypes.c_int
BCryptCloseAlgorithmProvider.argtypes = [
    wintypes.HANDLE,  # hAlgorithm : BCRYPT_ALG_HANDLE in/out
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('bcrypt.dll')
BCryptCloseAlgorithmProvider = Fiddle::Function.new(
  lib['BCryptCloseAlgorithmProvider'],
  [
    Fiddle::TYPE_VOIDP,  # hAlgorithm : BCRYPT_ALG_HANDLE in/out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "bcrypt")]
extern "system" {
    fn BCryptCloseAlgorithmProvider(
        hAlgorithm: *mut core::ffi::c_void,  // BCRYPT_ALG_HANDLE in/out
        dwFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("bcrypt.dll")]
public static extern int BCryptCloseAlgorithmProvider(IntPtr hAlgorithm, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'bcrypt_BCryptCloseAlgorithmProvider' -Namespace Win32 -PassThru
# $api::BCryptCloseAlgorithmProvider(hAlgorithm, dwFlags)
#uselib "bcrypt.dll"
#func global BCryptCloseAlgorithmProvider "BCryptCloseAlgorithmProvider" sptr, sptr
; BCryptCloseAlgorithmProvider hAlgorithm, dwFlags   ; 戻り値は stat
; hAlgorithm : BCRYPT_ALG_HANDLE in/out -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "bcrypt.dll"
#cfunc global BCryptCloseAlgorithmProvider "BCryptCloseAlgorithmProvider" sptr, int
; res = BCryptCloseAlgorithmProvider(hAlgorithm, dwFlags)
; hAlgorithm : BCRYPT_ALG_HANDLE in/out -> "sptr"
; dwFlags : DWORD -> "int"
; NTSTATUS BCryptCloseAlgorithmProvider(BCRYPT_ALG_HANDLE hAlgorithm, DWORD dwFlags)
#uselib "bcrypt.dll"
#cfunc global BCryptCloseAlgorithmProvider "BCryptCloseAlgorithmProvider" intptr, int
; res = BCryptCloseAlgorithmProvider(hAlgorithm, dwFlags)
; hAlgorithm : BCRYPT_ALG_HANDLE in/out -> "intptr"
; dwFlags : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	bcrypt = windows.NewLazySystemDLL("bcrypt.dll")
	procBCryptCloseAlgorithmProvider = bcrypt.NewProc("BCryptCloseAlgorithmProvider")
)

// hAlgorithm (BCRYPT_ALG_HANDLE in/out), dwFlags (DWORD)
r1, _, err := procBCryptCloseAlgorithmProvider.Call(
	uintptr(hAlgorithm),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // NTSTATUS
function BCryptCloseAlgorithmProvider(
  hAlgorithm: THandle;   // BCRYPT_ALG_HANDLE in/out
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'bcrypt.dll' name 'BCryptCloseAlgorithmProvider';
result := DllCall("bcrypt\BCryptCloseAlgorithmProvider"
    , "Ptr", hAlgorithm   ; BCRYPT_ALG_HANDLE in/out
    , "UInt", dwFlags   ; DWORD
    , "Int")   ; return: NTSTATUS
●BCryptCloseAlgorithmProvider(hAlgorithm, dwFlags) = DLL("bcrypt.dll", "int BCryptCloseAlgorithmProvider(void*, dword)")
# 呼び出し: BCryptCloseAlgorithmProvider(hAlgorithm, dwFlags)
# hAlgorithm : BCRYPT_ALG_HANDLE in/out -> "void*"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "bcrypt" fn BCryptCloseAlgorithmProvider(
    hAlgorithm: ?*anyopaque, // BCRYPT_ALG_HANDLE in/out
    dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc BCryptCloseAlgorithmProvider(
    hAlgorithm: pointer,  # BCRYPT_ALG_HANDLE in/out
    dwFlags: uint32  # DWORD
): int32 {.importc: "BCryptCloseAlgorithmProvider", stdcall, dynlib: "bcrypt.dll".}
pragma(lib, "bcrypt");
extern(Windows)
int BCryptCloseAlgorithmProvider(
    void* hAlgorithm,   // BCRYPT_ALG_HANDLE in/out
    uint dwFlags   // DWORD
);
ccall((:BCryptCloseAlgorithmProvider, "bcrypt.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32),
      hAlgorithm, dwFlags)
# hAlgorithm : BCRYPT_ALG_HANDLE in/out -> Ptr{Cvoid}
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t BCryptCloseAlgorithmProvider(
    void* hAlgorithm,
    uint32_t dwFlags);
]]
local bcrypt = ffi.load("bcrypt")
-- bcrypt.BCryptCloseAlgorithmProvider(hAlgorithm, dwFlags)
-- hAlgorithm : BCRYPT_ALG_HANDLE in/out
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('bcrypt.dll');
const BCryptCloseAlgorithmProvider = lib.func('__stdcall', 'BCryptCloseAlgorithmProvider', 'int32_t', ['void *', 'uint32_t']);
// BCryptCloseAlgorithmProvider(hAlgorithm, dwFlags)
// hAlgorithm : BCRYPT_ALG_HANDLE in/out -> 'void *'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("bcrypt.dll", {
  BCryptCloseAlgorithmProvider: { parameters: ["pointer", "u32"], result: "i32" },
});
// lib.symbols.BCryptCloseAlgorithmProvider(hAlgorithm, dwFlags)
// hAlgorithm : BCRYPT_ALG_HANDLE in/out -> "pointer"
// dwFlags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t BCryptCloseAlgorithmProvider(
    void* hAlgorithm,
    uint32_t dwFlags);
C, "bcrypt.dll");
// $ffi->BCryptCloseAlgorithmProvider(hAlgorithm, dwFlags);
// hAlgorithm : BCRYPT_ALG_HANDLE in/out
// 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 Bcrypt extends StdCallLibrary {
    Bcrypt INSTANCE = Native.load("bcrypt", Bcrypt.class);
    int BCryptCloseAlgorithmProvider(
        Pointer hAlgorithm,   // BCRYPT_ALG_HANDLE in/out
        int dwFlags   // DWORD
    );
}
@[Link("bcrypt")]
lib Libbcrypt
  fun BCryptCloseAlgorithmProvider = BCryptCloseAlgorithmProvider(
    hAlgorithm : Void*,   # BCRYPT_ALG_HANDLE in/out
    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 BCryptCloseAlgorithmProviderNative = Int32 Function(Pointer<Void>, Uint32);
typedef BCryptCloseAlgorithmProviderDart = int Function(Pointer<Void>, int);
final BCryptCloseAlgorithmProvider = DynamicLibrary.open('bcrypt.dll')
    .lookupFunction<BCryptCloseAlgorithmProviderNative, BCryptCloseAlgorithmProviderDart>('BCryptCloseAlgorithmProvider');
// hAlgorithm : BCRYPT_ALG_HANDLE in/out -> Pointer<Void>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function BCryptCloseAlgorithmProvider(
  hAlgorithm: THandle;   // BCRYPT_ALG_HANDLE in/out
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'bcrypt.dll' name 'BCryptCloseAlgorithmProvider';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "BCryptCloseAlgorithmProvider"
  c_BCryptCloseAlgorithmProvider :: Ptr () -> Word32 -> IO Int32
-- hAlgorithm : BCRYPT_ALG_HANDLE in/out -> Ptr ()
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let bcryptclosealgorithmprovider =
  foreign "BCryptCloseAlgorithmProvider"
    ((ptr void) @-> uint32_t @-> returning int32_t)
(* hAlgorithm : BCRYPT_ALG_HANDLE in/out -> (ptr void) *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library bcrypt (t "bcrypt.dll"))
(cffi:use-foreign-library bcrypt)

(cffi:defcfun ("BCryptCloseAlgorithmProvider" bcrypt-close-algorithm-provider :convention :stdcall) :int32
  (h-algorithm :pointer)   ; BCRYPT_ALG_HANDLE in/out
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $BCryptCloseAlgorithmProvider = Win32::API::More->new('bcrypt',
    'int BCryptCloseAlgorithmProvider(HANDLE hAlgorithm, DWORD dwFlags)');
# my $ret = $BCryptCloseAlgorithmProvider->Call($hAlgorithm, $dwFlags);
# hAlgorithm : BCRYPT_ALG_HANDLE in/out -> HANDLE
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。