Win32 API 日本語リファレンス
ホームSystem.Memory › AddSecureMemoryCacheCallback

AddSecureMemoryCacheCallback

関数
セキュアメモリキャッシュ用のコールバックを登録する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL AddSecureMemoryCacheCallback(
    PSECURE_MEMORY_CACHE_CALLBACK pfnCallBack
);

パラメーター

名前方向説明
pfnCallBackPSECURE_MEMORY_CACHE_CALLBACKin登録するアプリケーション定義の SecureMemoryCacheCallback 関数へのポインターです。

戻り値の型: BOOL

公式ドキュメント

セキュリティ保護されたメモリ範囲が解放されたとき、またはその保護属性が変更されたときに呼び出されるコールバック関数を登録します。

戻り値

関数が成功した場合、コールバック関数を登録し、 TRUE を返します。

関数が失敗した場合は FALSE を返します。拡張エラー情報を取得するには、 GetLastError 関数を呼び出します。

解説(Remarks)

高性能デバイスに対して直接 I/O を実行するアプリケーションは、通常、その I/O に使用するバッファーの仮想-物理 メモリマッピングをキャッシュします。デバイスのドライバーは、通常、 MmSecureVirtualMemory ルーチンを呼び出すことで、このメモリアドレス範囲をセキュリティ保護します。 これにより、ドライバーがメモリのセキュリティ保護を解除するまで、メモリ範囲が解放されたり、その保護属性が変更されたりすることを防ぎます。

アプリケーションは AddSecureMemoryCacheCallback を使用して、 メモリが解放されたとき、またはその保護属性が変更されたときに呼び出されるコールバック関数を登録できます。 これにより、アプリケーションはキャッシュしたメモリマッピングを無効化できます。詳細については、 SecureMemoryCacheCallback を参照してください。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0600 以降として定義します。詳細については、 Using the Windows Headers を参照してください。

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

各言語での呼び出し定義

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

BOOL AddSecureMemoryCacheCallback(
    PSECURE_MEMORY_CACHE_CALLBACK pfnCallBack
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool AddSecureMemoryCacheCallback(
    IntPtr pfnCallBack   // PSECURE_MEMORY_CACHE_CALLBACK
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function AddSecureMemoryCacheCallback(
    pfnCallBack As IntPtr   ' PSECURE_MEMORY_CACHE_CALLBACK
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pfnCallBack : PSECURE_MEMORY_CACHE_CALLBACK
Declare PtrSafe Function AddSecureMemoryCacheCallback Lib "kernel32" ( _
    ByVal pfnCallBack As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

AddSecureMemoryCacheCallback = ctypes.windll.kernel32.AddSecureMemoryCacheCallback
AddSecureMemoryCacheCallback.restype = wintypes.BOOL
AddSecureMemoryCacheCallback.argtypes = [
    ctypes.c_void_p,  # pfnCallBack : PSECURE_MEMORY_CACHE_CALLBACK
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
AddSecureMemoryCacheCallback = Fiddle::Function.new(
  lib['AddSecureMemoryCacheCallback'],
  [
    Fiddle::TYPE_VOIDP,  # pfnCallBack : PSECURE_MEMORY_CACHE_CALLBACK
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn AddSecureMemoryCacheCallback(
        pfnCallBack: *const core::ffi::c_void  // PSECURE_MEMORY_CACHE_CALLBACK
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool AddSecureMemoryCacheCallback(IntPtr pfnCallBack);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_AddSecureMemoryCacheCallback' -Namespace Win32 -PassThru
# $api::AddSecureMemoryCacheCallback(pfnCallBack)
#uselib "KERNEL32.dll"
#func global AddSecureMemoryCacheCallback "AddSecureMemoryCacheCallback" sptr
; AddSecureMemoryCacheCallback pfnCallBack   ; 戻り値は stat
; pfnCallBack : PSECURE_MEMORY_CACHE_CALLBACK -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global AddSecureMemoryCacheCallback "AddSecureMemoryCacheCallback" sptr
; res = AddSecureMemoryCacheCallback(pfnCallBack)
; pfnCallBack : PSECURE_MEMORY_CACHE_CALLBACK -> "sptr"
; BOOL AddSecureMemoryCacheCallback(PSECURE_MEMORY_CACHE_CALLBACK pfnCallBack)
#uselib "KERNEL32.dll"
#cfunc global AddSecureMemoryCacheCallback "AddSecureMemoryCacheCallback" intptr
; res = AddSecureMemoryCacheCallback(pfnCallBack)
; pfnCallBack : PSECURE_MEMORY_CACHE_CALLBACK -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procAddSecureMemoryCacheCallback = kernel32.NewProc("AddSecureMemoryCacheCallback")
)

// pfnCallBack (PSECURE_MEMORY_CACHE_CALLBACK)
r1, _, err := procAddSecureMemoryCacheCallback.Call(
	uintptr(pfnCallBack),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function AddSecureMemoryCacheCallback(
  pfnCallBack: Pointer   // PSECURE_MEMORY_CACHE_CALLBACK
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'AddSecureMemoryCacheCallback';
result := DllCall("KERNEL32\AddSecureMemoryCacheCallback"
    , "Ptr", pfnCallBack   ; PSECURE_MEMORY_CACHE_CALLBACK
    , "Int")   ; return: BOOL
●AddSecureMemoryCacheCallback(pfnCallBack) = DLL("KERNEL32.dll", "bool AddSecureMemoryCacheCallback(void*)")
# 呼び出し: AddSecureMemoryCacheCallback(pfnCallBack)
# pfnCallBack : PSECURE_MEMORY_CACHE_CALLBACK -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn AddSecureMemoryCacheCallback(
    pfnCallBack: ?*anyopaque // PSECURE_MEMORY_CACHE_CALLBACK
) callconv(std.os.windows.WINAPI) i32;
proc AddSecureMemoryCacheCallback(
    pfnCallBack: pointer  # PSECURE_MEMORY_CACHE_CALLBACK
): int32 {.importc: "AddSecureMemoryCacheCallback", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int AddSecureMemoryCacheCallback(
    void* pfnCallBack   // PSECURE_MEMORY_CACHE_CALLBACK
);
ccall((:AddSecureMemoryCacheCallback, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid},),
      pfnCallBack)
# pfnCallBack : PSECURE_MEMORY_CACHE_CALLBACK -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t AddSecureMemoryCacheCallback(
    void* pfnCallBack);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.AddSecureMemoryCacheCallback(pfnCallBack)
-- pfnCallBack : PSECURE_MEMORY_CACHE_CALLBACK
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const AddSecureMemoryCacheCallback = lib.func('__stdcall', 'AddSecureMemoryCacheCallback', 'int32_t', ['void *']);
// AddSecureMemoryCacheCallback(pfnCallBack)
// pfnCallBack : PSECURE_MEMORY_CACHE_CALLBACK -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("KERNEL32.dll", {
  AddSecureMemoryCacheCallback: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.AddSecureMemoryCacheCallback(pfnCallBack)
// pfnCallBack : PSECURE_MEMORY_CACHE_CALLBACK -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t AddSecureMemoryCacheCallback(
    void* pfnCallBack);
C, "KERNEL32.dll");
// $ffi->AddSecureMemoryCacheCallback(pfnCallBack);
// pfnCallBack : PSECURE_MEMORY_CACHE_CALLBACK
// 構造体/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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    boolean AddSecureMemoryCacheCallback(
        Callback pfnCallBack   // PSECURE_MEMORY_CACHE_CALLBACK
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun AddSecureMemoryCacheCallback = AddSecureMemoryCacheCallback(
    pfnCallBack : Void*   # PSECURE_MEMORY_CACHE_CALLBACK
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef AddSecureMemoryCacheCallbackNative = Int32 Function(Pointer<Void>);
typedef AddSecureMemoryCacheCallbackDart = int Function(Pointer<Void>);
final AddSecureMemoryCacheCallback = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<AddSecureMemoryCacheCallbackNative, AddSecureMemoryCacheCallbackDart>('AddSecureMemoryCacheCallback');
// pfnCallBack : PSECURE_MEMORY_CACHE_CALLBACK -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function AddSecureMemoryCacheCallback(
  pfnCallBack: Pointer   // PSECURE_MEMORY_CACHE_CALLBACK
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'AddSecureMemoryCacheCallback';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "AddSecureMemoryCacheCallback"
  c_AddSecureMemoryCacheCallback :: Ptr () -> IO CInt
-- pfnCallBack : PSECURE_MEMORY_CACHE_CALLBACK -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let addsecurememorycachecallback =
  foreign "AddSecureMemoryCacheCallback"
    ((ptr void) @-> returning int32_t)
(* pfnCallBack : PSECURE_MEMORY_CACHE_CALLBACK -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("AddSecureMemoryCacheCallback" add-secure-memory-cache-callback :convention :stdcall) :int32
  (pfn-call-back :pointer))   ; PSECURE_MEMORY_CACHE_CALLBACK
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $AddSecureMemoryCacheCallback = Win32::API::More->new('KERNEL32',
    'BOOL AddSecureMemoryCacheCallback(LPVOID pfnCallBack)');
# my $ret = $AddSecureMemoryCacheCallback->Call($pfnCallBack);
# pfnCallBack : PSECURE_MEMORY_CACHE_CALLBACK -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

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