Win32 API 日本語リファレンス
ホームUI.Shell › StrToIntExW

StrToIntExW

関数
進数指定に応じて文字列を整数に変換する。
DLLSHLWAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL StrToIntExW(
    LPCWSTR pszString,
    INT dwFlags,
    INT* piRet
);

パラメーター

名前方向説明
pszStringLPCWSTRin変換対象となる、null 終端された文字列へのポインター。文字列の有効な形式の詳細については、「解説」セクションを参照してください。
dwFlagsINTin

pszString を整数に変換する際の解析方法を指定する、以下のいずれかの値。

STIF_DEFAULT

pszString の文字列は 10 進値の表現を含みます。

STIF_SUPPORT_HEX

pszString の文字列は 10 進値または 16 進値のいずれかの表現を含みます。16 進数表現では、文字 A〜F は大文字と小文字を区別しないことに注意してください。

piRetINT*out

変換結果を受け取る int へのポインター。たとえば、文字列 "123" の場合、この値が指す整数には整数値 123 が格納されます。

この関数が FALSE を返す場合、この値は未定義です。

返される値が int 型の変数に収まりきらないほど大きい場合、このパラメーターには値の下位 32 ビットが格納されます。それを超える上位ビットは失われます。

- dwFlags.STIF_DEFAULT

pszString の文字列は 10 進値の表現を含みます。

- dwFlags.STIF_SUPPORT_HEX

pszString の文字列は 10 進値または 16 進値のいずれかの表現を含みます。16 進数表現では、文字 A〜F は大文字と小文字を区別しないことに注意してください。

戻り値の型: BOOL

公式ドキュメント

10進数または16進数を表す文字列を整数に変換します。(Unicode)

戻り値

型: BOOL

文字列が変換された場合は TRUE を返します。それ以外の場合は FALSE を返します。

解説(Remarks)

pszString パラメーターが指す文字列は、正常に解析されるために、以下のいずれかの形式である必要があります。

省略可能な符号には '-' または '+' の文字を使用できます。省略された場合、符号は正と見なされます。
注意 値が 16 進数として解析される場合、たとえ '-' 文字であっても省略可能な符号は無視されます。たとえば、文字列 "-0x1" は -1 ではなく 1 として解析されます。
pszString が指す文字列に無効な文字が含まれている場合、その文字が変換対象の文字列の終端と見なされ、残りは無視されます。たとえば、無効な 16 進数文字列 "0x00am123" が与えられた場合、StrToIntEx は "0x00a" のみを認識し、整数値 10 に変換して TRUE を返します。
メモ

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

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

各言語での呼び出し定義

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

BOOL StrToIntExW(
    LPCWSTR pszString,
    INT dwFlags,
    INT* piRet
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool StrToIntExW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszString,   // LPCWSTR
    int dwFlags,   // INT
    out int piRet   // INT* out
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function StrToIntExW(
    <MarshalAs(UnmanagedType.LPWStr)> pszString As String,   ' LPCWSTR
    dwFlags As Integer,   ' INT
    <Out> ByRef piRet As Integer   ' INT* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pszString : LPCWSTR
' dwFlags : INT
' piRet : INT* out
Declare PtrSafe Function StrToIntExW Lib "shlwapi" ( _
    ByVal pszString As LongPtr, _
    ByVal dwFlags As Long, _
    ByRef piRet As Long) 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

StrToIntExW = ctypes.windll.shlwapi.StrToIntExW
StrToIntExW.restype = wintypes.BOOL
StrToIntExW.argtypes = [
    wintypes.LPCWSTR,  # pszString : LPCWSTR
    ctypes.c_int,  # dwFlags : INT
    ctypes.POINTER(ctypes.c_int),  # piRet : INT* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
StrToIntExW = Fiddle::Function.new(
  lib['StrToIntExW'],
  [
    Fiddle::TYPE_VOIDP,  # pszString : LPCWSTR
    Fiddle::TYPE_INT,  # dwFlags : INT
    Fiddle::TYPE_VOIDP,  # piRet : INT* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shlwapi")]
extern "system" {
    fn StrToIntExW(
        pszString: *const u16,  // LPCWSTR
        dwFlags: i32,  // INT
        piRet: *mut i32  // INT* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern bool StrToIntExW([MarshalAs(UnmanagedType.LPWStr)] string pszString, int dwFlags, out int piRet);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_StrToIntExW' -Namespace Win32 -PassThru
# $api::StrToIntExW(pszString, dwFlags, piRet)
#uselib "SHLWAPI.dll"
#func global StrToIntExW "StrToIntExW" wptr, wptr, wptr
; StrToIntExW pszString, dwFlags, varptr(piRet)   ; 戻り値は stat
; pszString : LPCWSTR -> "wptr"
; dwFlags : INT -> "wptr"
; piRet : INT* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHLWAPI.dll"
#cfunc global StrToIntExW "StrToIntExW" wstr, int, var
; res = StrToIntExW(pszString, dwFlags, piRet)
; pszString : LPCWSTR -> "wstr"
; dwFlags : INT -> "int"
; piRet : INT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL StrToIntExW(LPCWSTR pszString, INT dwFlags, INT* piRet)
#uselib "SHLWAPI.dll"
#cfunc global StrToIntExW "StrToIntExW" wstr, int, var
; res = StrToIntExW(pszString, dwFlags, piRet)
; pszString : LPCWSTR -> "wstr"
; dwFlags : INT -> "int"
; piRet : INT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procStrToIntExW = shlwapi.NewProc("StrToIntExW")
)

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

extern "shlwapi" fn StrToIntExW(
    pszString: [*c]const u16, // LPCWSTR
    dwFlags: i32, // INT
    piRet: [*c]i32 // INT* out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc StrToIntExW(
    pszString: WideCString,  # LPCWSTR
    dwFlags: int32,  # INT
    piRet: ptr int32  # INT* out
): int32 {.importc: "StrToIntExW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shlwapi");
extern(Windows)
int StrToIntExW(
    const(wchar)* pszString,   // LPCWSTR
    int dwFlags,   // INT
    int* piRet   // INT* out
);
ccall((:StrToIntExW, "SHLWAPI.dll"), stdcall, Int32,
      (Cwstring, Int32, Ptr{Int32}),
      pszString, dwFlags, piRet)
# pszString : LPCWSTR -> Cwstring
# dwFlags : INT -> Int32
# piRet : INT* out -> Ptr{Int32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t StrToIntExW(
    const uint16_t* pszString,
    int32_t dwFlags,
    int32_t* piRet);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.StrToIntExW(pszString, dwFlags, piRet)
-- pszString : LPCWSTR
-- dwFlags : INT
-- piRet : INT* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const StrToIntExW = lib.func('__stdcall', 'StrToIntExW', 'int32_t', ['str16', 'int32_t', 'int32_t *']);
// StrToIntExW(pszString, dwFlags, piRet)
// pszString : LPCWSTR -> 'str16'
// dwFlags : INT -> 'int32_t'
// piRet : INT* out -> 'int32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  StrToIntExW: { parameters: ["buffer", "i32", "pointer"], result: "i32" },
});
// lib.symbols.StrToIntExW(pszString, dwFlags, piRet)
// pszString : LPCWSTR -> "buffer"
// dwFlags : INT -> "i32"
// piRet : INT* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t StrToIntExW(
    const uint16_t* pszString,
    int32_t dwFlags,
    int32_t* piRet);
C, "SHLWAPI.dll");
// $ffi->StrToIntExW(pszString, dwFlags, piRet);
// pszString : LPCWSTR
// dwFlags : INT
// piRet : INT* out
// 構造体/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 Shlwapi extends StdCallLibrary {
    Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class, W32APIOptions.UNICODE_OPTIONS);
    boolean StrToIntExW(
        WString pszString,   // LPCWSTR
        int dwFlags,   // INT
        IntByReference piRet   // INT* out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shlwapi")]
lib LibSHLWAPI
  fun StrToIntExW = StrToIntExW(
    pszString : UInt16*,   # LPCWSTR
    dwFlags : Int32,   # INT
    piRet : Int32*   # INT* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef StrToIntExWNative = Int32 Function(Pointer<Utf16>, Int32, Pointer<Int32>);
typedef StrToIntExWDart = int Function(Pointer<Utf16>, int, Pointer<Int32>);
final StrToIntExW = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<StrToIntExWNative, StrToIntExWDart>('StrToIntExW');
// pszString : LPCWSTR -> Pointer<Utf16>
// dwFlags : INT -> Int32
// piRet : INT* out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function StrToIntExW(
  pszString: PWideChar;   // LPCWSTR
  dwFlags: Integer;   // INT
  piRet: Pointer   // INT* out
): BOOL; stdcall;
  external 'SHLWAPI.dll' name 'StrToIntExW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "StrToIntExW"
  c_StrToIntExW :: CWString -> Int32 -> Ptr Int32 -> IO CInt
-- pszString : LPCWSTR -> CWString
-- dwFlags : INT -> Int32
-- piRet : INT* out -> Ptr Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let strtointexw =
  foreign "StrToIntExW"
    ((ptr uint16_t) @-> int32_t @-> (ptr int32_t) @-> returning int32_t)
(* pszString : LPCWSTR -> (ptr uint16_t) *)
(* dwFlags : INT -> int32_t *)
(* piRet : INT* out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("StrToIntExW" str-to-int-ex-w :convention :stdcall) :int32
  (psz-string (:string :encoding :utf-16le))   ; LPCWSTR
  (dw-flags :int32)   ; INT
  (pi-ret :pointer))   ; INT* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $StrToIntExW = Win32::API::More->new('SHLWAPI',
    'BOOL StrToIntExW(LPCWSTR pszString, int dwFlags, LPVOID piRet)');
# my $ret = $StrToIntExW->Call($pszString, $dwFlags, $piRet);
# pszString : LPCWSTR -> LPCWSTR
# dwFlags : INT -> int
# piRet : INT* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API