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

IsBadReadPtr

関数
指定範囲が読み取り可能かを検証する(非推奨)。
DLLKERNEL32.dll呼出規約winapi対応OSWindows XP 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

BOOL IsBadReadPtr(
    const void* lp,   // optional
    UINT_PTR ucb
);

パラメーター

名前型方向説明
lpvoid*inoptionalメモリブロックの先頭バイトへのポインターです。
ucbUINT_PTRinメモリブロックのサイズ(バイト単位)です。このパラメーターが 0 の場合、戻り値は 0 になります。

戻り値の型: BOOL

公式ドキュメント

呼び出し元プロセスが指定されたメモリ範囲に対する読み取りアクセス権を持っているかどうかを検証します。(IsBadReadPtr)

戻り値

呼び出し元プロセスが指定されたメモリ範囲内のすべてのバイトに対する読み取りアクセス権を持っている場合、戻り値は 0 になります。

呼び出し元プロセスが指定されたメモリ範囲内のすべてのバイトに対する読み取りアクセス権を持っていない場合、戻り値は 0 以外になります。

アプリケーションがデバッグ版としてコンパイルされており、プロセスが指定されたメモリ範囲内のすべてのバイトに対する読み取りアクセス権を持っていない場合、この関数はアサーションを発生させてデバッガーにブレークします。デバッガーを抜けると、関数は通常どおり処理を継続し、0 以外の値を返します。この動作はデバッグの補助として意図的に設計されています。

解説(Remarks)

この関数は通常、サードパーティ製ライブラリから返されたポインターを扱う際、サードパーティ製 DLL 内のメモリ管理の動作を判断できない場合に使用されます。

プロセス内のスレッドは、一方が他方の必要とするメモリを解放しないように協調して動作することが期待されます。この関数を使用しても、その必要性がなくなるわけではありません。これが守られない場合、アプリケーションは予測できない形で失敗する可能性があります。

無効である可能性のあるポインターを逆参照すると、他のスレッドでのスタック拡張が無効化されることがあります。スタック拡張が無効化されている状態でスレッドがスタックを使い果たすと、ポップアップのエラーウィンドウや診断情報を表示することなく、親プロセスが即座に終了します。

呼び出し元プロセスが指定されたメモリ範囲内の一部のバイトに対しては読み取りアクセス権を持っているものの、すべてのバイトに対しては持っていない場合、戻り値は 0 以外になります。

プリエンプティブなマルチタスク環境では、他のスレッドがテスト対象のメモリに対するプロセスのアクセス権を変更する可能性があります。関数がプロセスに指定されたメモリへの読み取りアクセス権があることを示した場合でも、そのメモリにアクセスする際には構造化例外処理を使用すべきです。構造化例外処理を使用することで、アクセス違反例外が発生した場合にシステムがプロセスに通知できるようになり、プロセスに例外を処理する機会が与えられます。

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

各言語での呼び出し定義

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

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

IsBadReadPtr = ctypes.windll.kernel32.IsBadReadPtr
IsBadReadPtr.restype = wintypes.BOOL
IsBadReadPtr.argtypes = [
    ctypes.POINTER(None),  # lp : void* optional
    ctypes.c_size_t,  # ucb : UINT_PTR
]
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procIsBadReadPtr = kernel32.NewProc("IsBadReadPtr")
)

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

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

typedef IsBadReadPtrNative = Int32 Function(Pointer<Void>, UintPtr);
typedef IsBadReadPtrDart = int Function(Pointer<Void>, int);
final IsBadReadPtr = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<IsBadReadPtrNative, IsBadReadPtrDart>('IsBadReadPtr');
// lp : void* optional -> Pointer<Void>
// ucb : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function IsBadReadPtr(
  lp: Pointer;   // void* optional
  ucb: NativeUInt   // UINT_PTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'IsBadReadPtr';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let isbadreadptr =
  foreign "IsBadReadPtr"
    ((ptr void) @-> size_t @-> returning int32_t)
(* lp : void* optional -> (ptr void) *)
(* ucb : 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 ("IsBadReadPtr" is-bad-read-ptr :convention :stdcall) :int32
  (lp :pointer)   ; void* optional
  (ucb :uint64))   ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $IsBadReadPtr = Win32::API::More->new('KERNEL32',
    'BOOL IsBadReadPtr(LPVOID lp, WPARAM ucb)');
# my $ret = $IsBadReadPtr->Call($lp, $ucb);
# lp : void* optional -> LPVOID
# ucb : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目