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

IsBadStringPtrA

関数
ANSI文字列ポインタが読み取り可能かを検証する(非推奨)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL IsBadStringPtrA(
    LPCSTR lpsz,   // optional
    UINT_PTR ucchMax
);

パラメーター

名前型方向説明
lpszLPCSTRinoptionalnull で終わる文字列へのポインター。Unicode または ASCII のいずれかです。
ucchMaxUINT_PTRin文字列の最大サイズ(TCHAR 単位)。この関数は、文字列の終端 null 文字までのすべての文字、またはこのパラメーターで指定された文字数のいずれか小さい方まで、読み取りアクセスを確認します。このパラメーターが 0 の場合、戻り値は 0 になります。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

呼び出し元プロセスが、文字列の終端 null 文字までのすべての文字、または ucchMax で指定された文字数までのすべての文字に対して読み取りアクセス権を持っている場合、戻り値は 0 になります。

呼び出し元プロセスが、文字列の終端 null 文字までのすべての文字、または ucchMax で指定された文字数までのすべての文字に対して読み取りアクセス権を持っていない場合、戻り値は 0 以外になります。

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

解説(Remarks)

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

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

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

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

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

メモ

winbase.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして IsBadStringPtr を定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存ではないコードと混在して使用すると、不一致が発生し、コンパイル エラーまたは実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規約を参照してください。

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

各言語での呼び出し定義

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL IsBadStringPtrA(
    LPCSTR lpsz,   // optional
    UINT_PTR ucchMax
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool IsBadStringPtrA(
    [MarshalAs(UnmanagedType.LPStr)] string lpsz,   // LPCSTR optional
    UIntPtr ucchMax   // UINT_PTR
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function IsBadStringPtrA(
    <MarshalAs(UnmanagedType.LPStr)> lpsz As String,   ' LPCSTR optional
    ucchMax As UIntPtr   ' UINT_PTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpsz : LPCSTR optional
' ucchMax : UINT_PTR
Declare PtrSafe Function IsBadStringPtrA Lib "kernel32" ( _
    ByVal lpsz As String, _
    ByVal ucchMax As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

IsBadStringPtrA = ctypes.windll.kernel32.IsBadStringPtrA
IsBadStringPtrA.restype = wintypes.BOOL
IsBadStringPtrA.argtypes = [
    wintypes.LPCSTR,  # lpsz : LPCSTR optional
    ctypes.c_size_t,  # ucchMax : UINT_PTR
]
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procIsBadStringPtrA = kernel32.NewProc("IsBadStringPtrA")
)

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

extern "kernel32" fn IsBadStringPtrA(
    lpsz: [*c]const u8, // LPCSTR optional
    ucchMax: usize // UINT_PTR
) callconv(std.os.windows.WINAPI) i32;
proc IsBadStringPtrA(
    lpsz: cstring,  # LPCSTR optional
    ucchMax: uint  # UINT_PTR
): int32 {.importc: "IsBadStringPtrA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int IsBadStringPtrA(
    const(char)* lpsz,   // LPCSTR optional
    size_t ucchMax   // UINT_PTR
);
ccall((:IsBadStringPtrA, "KERNEL32.dll"), stdcall, Int32,
      (Cstring, Csize_t),
      lpsz, ucchMax)
# lpsz : LPCSTR optional -> Cstring
# ucchMax : UINT_PTR -> Csize_t
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t IsBadStringPtrA(
    const char* lpsz,
    uintptr_t ucchMax);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.IsBadStringPtrA(lpsz, ucchMax)
-- lpsz : LPCSTR optional
-- ucchMax : UINT_PTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const IsBadStringPtrA = lib.func('__stdcall', 'IsBadStringPtrA', 'int32_t', ['str', 'uintptr_t']);
// IsBadStringPtrA(lpsz, ucchMax)
// lpsz : LPCSTR optional -> 'str'
// ucchMax : UINT_PTR -> 'uintptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  IsBadStringPtrA: { parameters: ["buffer", "usize"], result: "i32" },
});
// lib.symbols.IsBadStringPtrA(lpsz, ucchMax)
// lpsz : LPCSTR optional -> "buffer"
// ucchMax : UINT_PTR -> "usize"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t IsBadStringPtrA(
    const char* lpsz,
    size_t ucchMax);
C, "KERNEL32.dll");
// $ffi->IsBadStringPtrA(lpsz, ucchMax);
// lpsz : LPCSTR optional
// ucchMax : 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, W32APIOptions.ASCII_OPTIONS);
    boolean IsBadStringPtrA(
        String lpsz,   // LPCSTR optional
        long ucchMax   // UINT_PTR
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun IsBadStringPtrA = IsBadStringPtrA(
    lpsz : UInt8*,   # LPCSTR optional
    ucchMax : 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 IsBadStringPtrANative = Int32 Function(Pointer<Utf8>, UintPtr);
typedef IsBadStringPtrADart = int Function(Pointer<Utf8>, int);
final IsBadStringPtrA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<IsBadStringPtrANative, IsBadStringPtrADart>('IsBadStringPtrA');
// lpsz : LPCSTR optional -> Pointer<Utf8>
// ucchMax : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function IsBadStringPtrA(
  lpsz: PAnsiChar;   // LPCSTR optional
  ucchMax: NativeUInt   // UINT_PTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'IsBadStringPtrA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "IsBadStringPtrA"
  c_IsBadStringPtrA :: CString -> CUIntPtr -> IO CInt
-- lpsz : LPCSTR optional -> CString
-- ucchMax : UINT_PTR -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

関連項目

文字セット違い
公式の関連項目