StrToIntExA

関数

進数指定に応じて文字列を整数に変換する。

DLLSHLWAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL StrToIntExA(
    LPCSTR pszString,
    INT dwFlags,
    INT* piRet
);

パラメーター

名前	型	方向	説明
pszString	LPCSTR	in	変換対象となる、null で終端された文字列へのポインターです。文字列の有効な形式の詳細については、「解説」セクションを参照してください。
dwFlags	INT	in	pszString を整数に変換する際の解析方法を指定する、次のいずれかの値です。 STIF_DEFAULT pszString の文字列には 10 進数値の表現が含まれます。 STIF_SUPPORT_HEX pszString の文字列には、10 進数値または 16 進数値のいずれかの表現が含まれます。16 進数表現では、文字 A～F は大文字と小文字を区別しないことに注意してください。
piRet	INT*	out	変換された文字列を受け取る int へのポインターです。たとえば、文字列が "123" の場合、この値が指す整数には整数値 123 が格納されます。この関数が FALSE を返した場合、この値は未定義です。返される値が int 型の変数に収まらないほど大きい場合、このパラメーターにはその値の下位 32 ビットが格納されます。それを超える上位ビットはすべて失われます。

名前

型

方向

説明

pszString

LPCSTR

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

dwFlags

INT

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

STIF_SUPPORT_HEX

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

piRet

INT*

out

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

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

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

型: BOOL

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

解説(Remarks)

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

この形式は、どちらのフラグでも 10 進数値として受け入れられます。
```
(省略可能な空白)(省略可能な符号)(1 桁以上の 10 進数字)
```

STIF_SUPPORT_HEX フラグを渡す場合、16 進数値にはこれらの形式が必要です。

(省略可能な空白)(省略可能な符号)0x(1 桁以上の 16 進数字)

(省略可能な空白)(省略可能な符号)0X(1 桁以上の 16 進数字)

省略可能な符号は文字 '-' または '+' です。省略した場合、符号は正と見なされます。

注値が 16 進数として解析される場合、省略可能な符号は '-' 文字であっても無視されます。たとえば、文字列 "-0x1" は -1 ではなく 1 として解析されます。

pszString が指す文字列に無効な文字が含まれる場合、その文字が変換対象文字列の終端と見なされ、残りは無視されます。たとえば、無効な 16 進数文字列 "0x00am123" が与えられた場合、StrToIntEx は "0x00a" のみを認識し、整数値 10 に変換して TRUE を返します。

メモ

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

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

各言語での呼び出し定義

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

BOOL StrToIntExA(
    LPCSTR pszString,
    INT dwFlags,
    INT* piRet
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool StrToIntExA(
    [MarshalAs(UnmanagedType.LPStr)] string pszString,   // LPCSTR
    int dwFlags,   // INT
    out int piRet   // INT* out
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function StrToIntExA(
    <MarshalAs(UnmanagedType.LPStr)> pszString As String,   ' LPCSTR
    dwFlags As Integer,   ' INT
    <Out> ByRef piRet As Integer   ' INT* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pszString : LPCSTR
' dwFlags : INT
' piRet : INT* out
Declare PtrSafe Function StrToIntExA Lib "shlwapi" ( _
    ByVal pszString As String, _
    ByVal dwFlags As Long, _
    ByRef piRet As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

StrToIntExA = ctypes.windll.shlwapi.StrToIntExA
StrToIntExA.restype = wintypes.BOOL
StrToIntExA.argtypes = [
    wintypes.LPCSTR,  # pszString : LPCSTR
    ctypes.c_int,  # dwFlags : INT
    ctypes.POINTER(ctypes.c_int),  # piRet : INT* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
StrToIntExA = Fiddle::Function.new(
  lib['StrToIntExA'],
  [
    Fiddle::TYPE_VOIDP,  # pszString : LPCSTR
    Fiddle::TYPE_INT,  # dwFlags : INT
    Fiddle::TYPE_VOIDP,  # piRet : INT* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "shlwapi")]
extern "system" {
    fn StrToIntExA(
        pszString: *const u8,  // LPCSTR
        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.Ansi)]
public static extern bool StrToIntExA([MarshalAs(UnmanagedType.LPStr)] string pszString, int dwFlags, out int piRet);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_StrToIntExA' -Namespace Win32 -PassThru
# $api::StrToIntExA(pszString, dwFlags, piRet)

#uselib "SHLWAPI.dll"
#func global StrToIntExA "StrToIntExA" sptr, sptr, sptr
; StrToIntExA pszString, dwFlags, varptr(piRet)   ; 戻り値は stat
; pszString : LPCSTR -> "sptr"
; dwFlags : INT -> "sptr"
; piRet : INT* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHLWAPI.dll"
#cfunc global StrToIntExA "StrToIntExA" str, int, var
; res = StrToIntExA(pszString, dwFlags, piRet)
; pszString : LPCSTR -> "str"
; dwFlags : INT -> "int"
; piRet : INT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll"
#cfunc global StrToIntExA "StrToIntExA" str, int, sptr
; res = StrToIntExA(pszString, dwFlags, varptr(piRet))
; pszString : LPCSTR -> "str"
; dwFlags : INT -> "int"
; piRet : INT* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。