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

NCryptNotifyChangeKey

関数
永続キーの変更通知をイベントで受け取るよう登録する。
DLLncrypt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT NCryptNotifyChangeKey(
    NCRYPT_PROV_HANDLE hProvider,
    HANDLE* phEvent,
    NCRYPT_FLAGS dwFlags
);

パラメーター

名前方向説明
hProviderNCRYPT_PROV_HANDLEinキーストレージプロバイダーのハンドル。このハンドルは NCryptOpenStorageProvider 関数を使用して取得します。
phEventHANDLE*inoutキー変更通知イベントハンドルを受け取る、または保持する HANDLE 変数のアドレス。これは FindFirstChangeNotification 関数が返すものと同じハンドルです。詳細については dwFlags パラメーターの説明を参照してください。
dwFlagsNCRYPT_FLAGSin

この関数の動作を変更するフラグのセット。このパラメーターには、次の値の 1 つ以上を組み合わせて指定します。

意味
NCRYPT_REGISTER_NOTIFY_FLAG
0x00000001
新しい変更通知を作成します。phEvent パラメーターがキー変更通知ハンドルを受け取ります。
NCRYPT_UNREGISTER_NOTIFY_FLAG
0x00000002
既存の変更通知を削除します。phEvent パラメーターには有効なキー変更通知ハンドルが含まれている必要があります。このフラグを指定してこの関数を呼び出すと、このハンドルは無効になり、INVALID_HANDLE_VALUE 値がこのハンドルに格納されます。
NCRYPT_MACHINE_KEY_FLAG
0x00000020
マシンキーストア内のキーに対する変更通知を受け取ります。このフラグを指定しない場合、変更通知イベントは呼び出し元ユーザーのキーストア内のキーに対してのみ発生します。このフラグは NCRYPT_REGISTER_NOTIFY_FLAG フラグと組み合わせた場合にのみ有効です。

戻り値の型: HRESULT

公式ドキュメント

キー変更通知を作成または削除します。

戻り値

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

戻り値には、次のものが含まれますが、これらに限定されません。

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

解説(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 NCryptNotifyChangeKey(
    NCRYPT_PROV_HANDLE hProvider,
    HANDLE* phEvent,
    NCRYPT_FLAGS dwFlags
);
[DllImport("ncrypt.dll", ExactSpelling = true)]
static extern int NCryptNotifyChangeKey(
    UIntPtr hProvider,   // NCRYPT_PROV_HANDLE
    IntPtr phEvent,   // HANDLE* in/out
    uint dwFlags   // NCRYPT_FLAGS
);
<DllImport("ncrypt.dll", ExactSpelling:=True)>
Public Shared Function NCryptNotifyChangeKey(
    hProvider As UIntPtr,   ' NCRYPT_PROV_HANDLE
    phEvent As IntPtr,   ' HANDLE* in/out
    dwFlags As UInteger   ' NCRYPT_FLAGS
) As Integer
End Function
' hProvider : NCRYPT_PROV_HANDLE
' phEvent : HANDLE* in/out
' dwFlags : NCRYPT_FLAGS
Declare PtrSafe Function NCryptNotifyChangeKey Lib "ncrypt" ( _
    ByVal hProvider As LongPtr, _
    ByVal phEvent 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

NCryptNotifyChangeKey = ctypes.windll.ncrypt.NCryptNotifyChangeKey
NCryptNotifyChangeKey.restype = ctypes.c_int
NCryptNotifyChangeKey.argtypes = [
    ctypes.c_size_t,  # hProvider : NCRYPT_PROV_HANDLE
    ctypes.c_void_p,  # phEvent : HANDLE* in/out
    wintypes.DWORD,  # dwFlags : NCRYPT_FLAGS
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ncrypt = windows.NewLazySystemDLL("ncrypt.dll")
	procNCryptNotifyChangeKey = ncrypt.NewProc("NCryptNotifyChangeKey")
)

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

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

typedef NCryptNotifyChangeKeyNative = Int32 Function(UintPtr, Pointer<Void>, Uint32);
typedef NCryptNotifyChangeKeyDart = int Function(int, Pointer<Void>, int);
final NCryptNotifyChangeKey = DynamicLibrary.open('ncrypt.dll')
    .lookupFunction<NCryptNotifyChangeKeyNative, NCryptNotifyChangeKeyDart>('NCryptNotifyChangeKey');
// hProvider : NCRYPT_PROV_HANDLE -> UintPtr
// phEvent : HANDLE* in/out -> Pointer<Void>
// dwFlags : NCRYPT_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function NCryptNotifyChangeKey(
  hProvider: NativeUInt;   // NCRYPT_PROV_HANDLE
  phEvent: Pointer;   // HANDLE* in/out
  dwFlags: DWORD   // NCRYPT_FLAGS
): Integer; stdcall;
  external 'ncrypt.dll' name 'NCryptNotifyChangeKey';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "NCryptNotifyChangeKey"
  c_NCryptNotifyChangeKey :: CUIntPtr -> Ptr () -> Word32 -> IO Int32
-- hProvider : NCRYPT_PROV_HANDLE -> CUIntPtr
-- phEvent : HANDLE* in/out -> Ptr ()
-- dwFlags : NCRYPT_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ncryptnotifychangekey =
  foreign "NCryptNotifyChangeKey"
    (size_t @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* hProvider : NCRYPT_PROV_HANDLE -> size_t *)
(* phEvent : HANDLE* in/out -> (ptr void) *)
(* dwFlags : NCRYPT_FLAGS -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ncrypt (t "ncrypt.dll"))
(cffi:use-foreign-library ncrypt)

(cffi:defcfun ("NCryptNotifyChangeKey" ncrypt-notify-change-key :convention :stdcall) :int32
  (h-provider :uint64)   ; NCRYPT_PROV_HANDLE
  (ph-event :pointer)   ; HANDLE* in/out
  (dw-flags :uint32))   ; NCRYPT_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NCryptNotifyChangeKey = Win32::API::More->new('ncrypt',
    'int NCryptNotifyChangeKey(WPARAM hProvider, HANDLE phEvent, DWORD dwFlags)');
# my $ret = $NCryptNotifyChangeKey->Call($hProvider, $phEvent, $dwFlags);
# hProvider : NCRYPT_PROV_HANDLE -> WPARAM
# phEvent : HANDLE* in/out -> HANDLE
# dwFlags : NCRYPT_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型