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

NCryptDeleteKey

関数
永続キーをストレージから削除する。
DLLncrypt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT NCryptDeleteKey(
    NCRYPT_KEY_HANDLE hKey,
    DWORD dwFlags
);

パラメーター

名前方向説明
hKeyNCRYPT_KEY_HANDLEin

削除するキーのハンドル。このハンドルは NCryptOpenKey 関数を使用して取得します。

注意 NCryptDeleteKey 関数はキーを削除し、ハンドルを解放します。NCryptDeleteKey が失敗した場合、アプリケーションは NCryptFreeObject 関数を使用してハンドルを解放できます。
dwFlagsDWORDin

関数の動作を変更するフラグ。0、または各キーストレージプロバイダー固有の値の組み合わせを指定できます。

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

戻り値の型: HRESULT

公式ドキュメント

CNG キーをストレージから削除します。

戻り値

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

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

戻り値 説明
ERROR_SUCCESS
関数は成功しました。
NTE_BAD_FLAGS
dwFlags パラメーターに有効でない値が含まれています。
NTE_INVALID_HANDLE
hKey パラメーターが有効ではありません。

解説(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 NCryptDeleteKey(
    NCRYPT_KEY_HANDLE hKey,
    DWORD dwFlags
);
[DllImport("ncrypt.dll", ExactSpelling = true)]
static extern int NCryptDeleteKey(
    UIntPtr hKey,   // NCRYPT_KEY_HANDLE
    uint dwFlags   // DWORD
);
<DllImport("ncrypt.dll", ExactSpelling:=True)>
Public Shared Function NCryptDeleteKey(
    hKey As UIntPtr,   ' NCRYPT_KEY_HANDLE
    dwFlags As UInteger   ' DWORD
) As Integer
End Function
' hKey : NCRYPT_KEY_HANDLE
' dwFlags : DWORD
Declare PtrSafe Function NCryptDeleteKey Lib "ncrypt" ( _
    ByVal hKey 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

NCryptDeleteKey = ctypes.windll.ncrypt.NCryptDeleteKey
NCryptDeleteKey.restype = ctypes.c_int
NCryptDeleteKey.argtypes = [
    ctypes.c_size_t,  # hKey : NCRYPT_KEY_HANDLE
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ncrypt = windows.NewLazySystemDLL("ncrypt.dll")
	procNCryptDeleteKey = ncrypt.NewProc("NCryptDeleteKey")
)

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

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

foreign import stdcall safe "NCryptDeleteKey"
  c_NCryptDeleteKey :: CUIntPtr -> Word32 -> IO Int32
-- hKey : NCRYPT_KEY_HANDLE -> CUIntPtr
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ncryptdeletekey =
  foreign "NCryptDeleteKey"
    (size_t @-> uint32_t @-> returning int32_t)
(* hKey : NCRYPT_KEY_HANDLE -> size_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 ("NCryptDeleteKey" ncrypt-delete-key :convention :stdcall) :int32
  (h-key :uint64)   ; NCRYPT_KEY_HANDLE
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NCryptDeleteKey = Win32::API::More->new('ncrypt',
    'int NCryptDeleteKey(WPARAM hKey, DWORD dwFlags)');
# my $ret = $NCryptDeleteKey->Call($hKey, $dwFlags);
# hKey : NCRYPT_KEY_HANDLE -> WPARAM
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目