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

ResetWriteWatch

関数
指定メモリ領域の書き込み監視状態をリセットする。
DLLKERNEL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD ResetWriteWatch(
    void* lpBaseAddress,
    UINT_PTR dwRegionSize
);

パラメーター

名前方向説明
lpBaseAddressvoid*in

書き込み追跡状態をリセットするメモリ領域のベースアドレスへのポインター。

このアドレスは、 VirtualAlloc 関数によって MEM_WRITE_WATCH を指定して割り当てられたメモリ領域内にある必要があります。

dwRegionSizeUINT_PTRin書き込み追跡情報をリセットするメモリ領域のサイズ(バイト単位)。

戻り値の型: DWORD

公式ドキュメント

仮想メモリ領域の書き込み追跡状態をリセットします。以降の GetWriteWatch 関数の呼び出しでは、リセット操作以降に書き込まれたページのみが報告されます。

戻り値

関数が成功した場合、戻り値は 0(ゼロ)です。

関数が失敗した場合、戻り値は 0 以外の値です。

解説(Remarks)

ResetWriteWatch 関数は、ガベージ コレクターのようなアプリケーションにとって役立ちます。アプリケーションは GetWriteWatch 関数を呼び出して書き込まれたページの一覧を取得し、クリーンアップ操作の一環としてそれらのページに書き込みます。その後、ガベージ コレクターは ResetWriteWatch を呼び出して、クリーンアップによって生じた書き込み追跡レコードを削除します。

GetWriteWatch を呼び出す際に WRITE_WATCH_FLAG_RESET を指定することによっても、メモリ領域の書き込み追跡状態をリセットできます。

ResetWriteWatch を使用する場合は、 GetWriteWatch の呼び出しと ResetWriteWatch の呼び出しの間隔の間に、どのスレッドもその領域に書き込まないようにする必要があります。そうしないと、検出されない書き込み済みページが生じる可能性があります。

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

各言語での呼び出し定義

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

DWORD ResetWriteWatch(
    void* lpBaseAddress,
    UINT_PTR dwRegionSize
);
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern uint ResetWriteWatch(
    IntPtr lpBaseAddress,   // void*
    UIntPtr dwRegionSize   // UINT_PTR
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function ResetWriteWatch(
    lpBaseAddress As IntPtr,   ' void*
    dwRegionSize As UIntPtr   ' UINT_PTR
) As UInteger
End Function
' lpBaseAddress : void*
' dwRegionSize : UINT_PTR
Declare PtrSafe Function ResetWriteWatch Lib "kernel32" ( _
    ByVal lpBaseAddress As LongPtr, _
    ByVal dwRegionSize As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ResetWriteWatch = ctypes.windll.kernel32.ResetWriteWatch
ResetWriteWatch.restype = wintypes.DWORD
ResetWriteWatch.argtypes = [
    ctypes.POINTER(None),  # lpBaseAddress : void*
    ctypes.c_size_t,  # dwRegionSize : UINT_PTR
]
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procResetWriteWatch = kernel32.NewProc("ResetWriteWatch")
)

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

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

typedef ResetWriteWatchNative = Uint32 Function(Pointer<Void>, UintPtr);
typedef ResetWriteWatchDart = int Function(Pointer<Void>, int);
final ResetWriteWatch = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<ResetWriteWatchNative, ResetWriteWatchDart>('ResetWriteWatch');
// lpBaseAddress : void* -> Pointer<Void>
// dwRegionSize : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ResetWriteWatch(
  lpBaseAddress: Pointer;   // void*
  dwRegionSize: NativeUInt   // UINT_PTR
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'ResetWriteWatch';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ResetWriteWatch"
  c_ResetWriteWatch :: Ptr () -> CUIntPtr -> IO Word32
-- lpBaseAddress : void* -> Ptr ()
-- dwRegionSize : UINT_PTR -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let resetwritewatch =
  foreign "ResetWriteWatch"
    ((ptr void) @-> size_t @-> returning uint32_t)
(* lpBaseAddress : void* -> (ptr void) *)
(* dwRegionSize : UINT_PTR -> size_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("ResetWriteWatch" reset-write-watch :convention :stdcall) :uint32
  (lp-base-address :pointer)   ; void*
  (dw-region-size :uint64))   ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ResetWriteWatch = Win32::API::More->new('KERNEL32',
    'DWORD ResetWriteWatch(LPVOID lpBaseAddress, WPARAM dwRegionSize)');
# my $ret = $ResetWriteWatch->Call($lpBaseAddress, $dwRegionSize);
# lpBaseAddress : void* -> LPVOID
# dwRegionSize : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目