StrToInt64ExA

関数

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

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

シグネチャ

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

BOOL StrToInt64ExA(
    LPCSTR pszString,
    INT dwFlags,
    LONGLONG* pllRet
);

パラメーター

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

名前

型

方向

説明

pszString

LPCSTR

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

dwFlags

INT

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

STIF_SUPPORT_HEX

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

pllRet

LONGLONG*

out

変換された文字列の64ビット整数値を受け取る LONGLONG 型の変数へのポインター。たとえば文字列 "123" の場合、この値が指す整数は値 123 を受け取ります。

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

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

戻り値の型: BOOL

公式ドキュメント

10進数または16進数の値を表す文字列を64ビット整数に変換します。(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" の場合、StrToInt64Ex は "0x00a" のみを認識して整数値 10 に変換し、TRUE を返します。

pllRet が NULL の場合、関数は実際の変換を行いませんが、文字列を変換できるならば TRUE を返します。

メモ

shlwapi.h ヘッダーは StrToInt64Ex を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング中立なエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、「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 StrToInt64ExA(
    LPCSTR pszString,
    INT dwFlags,
    LONGLONG* pllRet
);

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

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "shlwapi")]
extern "system" {
    fn StrToInt64ExA(
        pszString: *const u8,  // LPCSTR
        dwFlags: i32,  // INT
        pllRet: *mut i64  // LONGLONG* 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 StrToInt64ExA([MarshalAs(UnmanagedType.LPStr)] string pszString, int dwFlags, out long pllRet);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_StrToInt64ExA' -Namespace Win32 -PassThru
# $api::StrToInt64ExA(pszString, dwFlags, pllRet)

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

出力引数:

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