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

IsBadStringPtrW

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

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

BOOL IsBadStringPtrW(
    LPCWSTR lpsz,   // optional
    UINT_PTR ucchMax
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

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

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

解説(Remarks)

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

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

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

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

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

メモ

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

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

各言語での呼び出し定義

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

BOOL IsBadStringPtrW(
    LPCWSTR lpsz,   // optional
    UINT_PTR ucchMax
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool IsBadStringPtrW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpsz,   // LPCWSTR optional
    UIntPtr ucchMax   // UINT_PTR
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function IsBadStringPtrW(
    <MarshalAs(UnmanagedType.LPWStr)> lpsz As String,   ' LPCWSTR optional
    ucchMax As UIntPtr   ' UINT_PTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpsz : LPCWSTR optional
' ucchMax : UINT_PTR
Declare PtrSafe Function IsBadStringPtrW Lib "kernel32" ( _
    ByVal lpsz As LongPtr, _
    ByVal ucchMax As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

lib = Fiddle.dlopen('KERNEL32.dll')
IsBadStringPtrW = Fiddle::Function.new(
  lib['IsBadStringPtrW'],
  [
    Fiddle::TYPE_VOIDP,  # lpsz : LPCWSTR optional
    Fiddle::TYPE_UINTPTR_T,  # ucchMax : UINT_PTR
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn IsBadStringPtrW(
        lpsz: *const u16,  // LPCWSTR 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.Unicode)]
public static extern bool IsBadStringPtrW([MarshalAs(UnmanagedType.LPWStr)] string lpsz, UIntPtr ucchMax);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_IsBadStringPtrW' -Namespace Win32 -PassThru
# $api::IsBadStringPtrW(lpsz, ucchMax)
#uselib "KERNEL32.dll"
#func global IsBadStringPtrW "IsBadStringPtrW" wptr, wptr
; IsBadStringPtrW lpsz, ucchMax   ; 戻り値は stat
; lpsz : LPCWSTR optional -> "wptr"
; ucchMax : UINT_PTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global IsBadStringPtrW "IsBadStringPtrW" wstr, sptr
; res = IsBadStringPtrW(lpsz, ucchMax)
; lpsz : LPCWSTR optional -> "wstr"
; ucchMax : UINT_PTR -> "sptr"
; BOOL IsBadStringPtrW(LPCWSTR lpsz, UINT_PTR ucchMax)
#uselib "KERNEL32.dll"
#cfunc global IsBadStringPtrW "IsBadStringPtrW" wstr, intptr
; res = IsBadStringPtrW(lpsz, ucchMax)
; lpsz : LPCWSTR optional -> "wstr"
; ucchMax : UINT_PTR -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procIsBadStringPtrW = kernel32.NewProc("IsBadStringPtrW")
)

// lpsz (LPCWSTR optional), ucchMax (UINT_PTR)
r1, _, err := procIsBadStringPtrW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpsz))),
	uintptr(ucchMax),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function IsBadStringPtrW(
  lpsz: PWideChar;   // LPCWSTR optional
  ucchMax: NativeUInt   // UINT_PTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'IsBadStringPtrW';
result := DllCall("KERNEL32\IsBadStringPtrW"
    , "WStr", lpsz   ; LPCWSTR optional
    , "UPtr", ucchMax   ; UINT_PTR
    , "Int")   ; return: BOOL
●IsBadStringPtrW(lpsz, ucchMax) = DLL("KERNEL32.dll", "bool IsBadStringPtrW(char*, int)")
# 呼び出し: IsBadStringPtrW(lpsz, ucchMax)
# lpsz : LPCWSTR optional -> "char*"
# ucchMax : UINT_PTR -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn IsBadStringPtrW(
    lpsz: [*c]const u16, // LPCWSTR optional
    ucchMax: usize // UINT_PTR
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc IsBadStringPtrW(
    lpsz: WideCString,  # LPCWSTR optional
    ucchMax: uint  # UINT_PTR
): int32 {.importc: "IsBadStringPtrW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
int IsBadStringPtrW(
    const(wchar)* lpsz,   // LPCWSTR optional
    size_t ucchMax   // UINT_PTR
);
ccall((:IsBadStringPtrW, "KERNEL32.dll"), stdcall, Int32,
      (Cwstring, Csize_t),
      lpsz, ucchMax)
# lpsz : LPCWSTR optional -> Cwstring
# ucchMax : UINT_PTR -> Csize_t
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t IsBadStringPtrW(
    const uint16_t* lpsz,
    uintptr_t ucchMax);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.IsBadStringPtrW(lpsz, ucchMax)
-- lpsz : LPCWSTR optional
-- ucchMax : UINT_PTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const IsBadStringPtrW = lib.func('__stdcall', 'IsBadStringPtrW', 'int32_t', ['str16', 'uintptr_t']);
// IsBadStringPtrW(lpsz, ucchMax)
// lpsz : LPCWSTR optional -> 'str16'
// ucchMax : UINT_PTR -> 'uintptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  IsBadStringPtrW: { parameters: ["buffer", "usize"], result: "i32" },
});
// lib.symbols.IsBadStringPtrW(lpsz, ucchMax)
// lpsz : LPCWSTR optional -> "buffer"
// ucchMax : UINT_PTR -> "usize"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t IsBadStringPtrW(
    const uint16_t* lpsz,
    size_t ucchMax);
C, "KERNEL32.dll");
// $ffi->IsBadStringPtrW(lpsz, ucchMax);
// lpsz : LPCWSTR 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.UNICODE_OPTIONS);
    boolean IsBadStringPtrW(
        WString lpsz,   // LPCWSTR optional
        long ucchMax   // UINT_PTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun IsBadStringPtrW = IsBadStringPtrW(
    lpsz : UInt16*,   # LPCWSTR 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 IsBadStringPtrWNative = Int32 Function(Pointer<Utf16>, UintPtr);
typedef IsBadStringPtrWDart = int Function(Pointer<Utf16>, int);
final IsBadStringPtrW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<IsBadStringPtrWNative, IsBadStringPtrWDart>('IsBadStringPtrW');
// lpsz : LPCWSTR optional -> Pointer<Utf16>
// ucchMax : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function IsBadStringPtrW(
  lpsz: PWideChar;   // LPCWSTR optional
  ucchMax: NativeUInt   // UINT_PTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'IsBadStringPtrW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let isbadstringptrw =
  foreign "IsBadStringPtrW"
    ((ptr uint16_t) @-> size_t @-> returning int32_t)
(* lpsz : LPCWSTR optional -> (ptr uint16_t) *)
(* 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 ("IsBadStringPtrW" is-bad-string-ptr-w :convention :stdcall) :int32
  (lpsz (:string :encoding :utf-16le))   ; LPCWSTR optional
  (ucch-max :uint64))   ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $IsBadStringPtrW = Win32::API::More->new('KERNEL32',
    'BOOL IsBadStringPtrW(LPCWSTR lpsz, WPARAM ucchMax)');
# my $ret = $IsBadStringPtrW->Call($lpsz, $ucchMax);
# lpsz : LPCWSTR optional -> LPCWSTR
# ucchMax : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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