GetNumberFormatA

関数

指定ロケールに従い数値を文字列へ整形する。ANSI版。

DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

INT GetNumberFormatA(
    DWORD Locale,
    DWORD dwFlags,
    LPCSTR lpValue,
    const NUMBERFMTA* lpFormat,   // optional
    LPSTR lpNumberStr,   // optional
    INT cchNumber
);

パラメーター

名前	型	方向	説明
Locale	DWORD	in	ロケールを指定するロケール識別子。MAKELCID マクロを使用してロケール識別子を作成するか、次の定義済みの値のいずれかを使用できます。 LOCALE_CUSTOM_DEFAULT LOCALE_CUSTOM_UI_DEFAULT LOCALE_CUSTOM_UNSPECIFIED LOCALE_INVARIANT LOCALE_SYSTEM_DEFAULT LOCALE_USER_DEFAULT
dwFlags	DWORD	in	関数の動作を制御するフラグ。lpFormat が NULL に設定されていない場合、アプリケーションはこのパラメーターを 0 に設定する必要があります。この場合、関数はロケールの既定の数値書式に対するユーザーのオーバーライドを使用して文字列を書式設定します。lpFormat が NULL に設定されている場合、アプリケーションは LOCALE_NOUSEROVERRIDE を指定して、指定したロケールのシステム既定の数値書式を使用して文字列を書式設定できます。注意 LOCALE_NOUSEROVERRIDE の使用はユーザー設定を無効にするため、強く非推奨とされています。
lpValue	LPCSTR	in	書式設定する数値文字列を含む、null で終わる文字列へのポインター。この文字列には次の文字のみを含めることができます。それ以外の文字はすべて無効です。lpValue が指す文字列がこれらの規則から逸脱している場合、関数はエラーを返します。「0」から「9」までの文字。数値が浮動小数点値の場合は、1 つの小数点(ドット)。数値が負の値の場合は、先頭の文字位置にマイナス記号。
lpFormat	NUMBERFMTA*	inoptional	数値の書式設定情報を含み、すべてのメンバーが適切な値に設定された NUMBERFMT 構造体へのポインター。アプリケーションがこのパラメーターを NULL に設定しない場合、関数はロケールの書式設定情報を使用します。
lpNumberStr	LPSTR	outoptional	この関数が書式設定済みの数値文字列を取得するバッファーへのポインター。
cchNumber	INT	in	lpNumberStr が指す数値文字列バッファーのサイズ(TCHAR 値単位)。代わりに、アプリケーションはこのパラメーターを 0 に設定することもできます。この場合、関数は数値文字列バッファーに必要なサイズを返し、lpNumberStr パラメーターは使用しません。

戻り値の型: INT

公式ドキュメント

数値文字列を、識別子で指定したロケール用にカスタマイズされた数値文字列として書式設定します。(ANSI)

戻り値

成功した場合、lpNumberStr が指すバッファーに取得された TCHAR 値の数を返します。cchNumber パラメーターが 0 に設定されている場合、関数は、終端の null 文字を含む、書式設定済みの数値文字列を保持するために必要な文字数を返します。

関数が成功しなかった場合は 0 を返します。拡張エラー情報を取得するには、アプリケーションは GetLastError を呼び出すことができます。この関数は次のいずれかのエラーコードを返すことがあります。

ERROR_INSUFFICIENT_BUFFER。指定されたバッファーサイズが十分な大きさではなかったか、誤って NULL に設定されていました。
ERROR_INVALID_FLAGS。フラグに指定された値が無効でした。
ERROR_INVALID_PARAMETER。いずれかのパラメーター値が無効でした。
ERROR_OUTOFMEMORY。この操作を完了するための十分な記憶域がありませんでした。

解説(Remarks)

この関数はカスタムロケールからデータを取得できます。データがコンピューター間やアプリケーションの実行間で同一であることは保証されません。アプリケーションでデータを保持または送信する必要がある場合は、永続的なロケールデータの使用を参照してください。

この関数の ANSI バージョンを Unicode 専用のロケール識別子と共に使用すると、オペレーティングシステムがシステムコードページを使用するため、関数が成功することがあります。ただし、システムコードページで未定義の文字は、文字列内で疑問符(?)として表示されます。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

INT GetNumberFormatA(
    DWORD Locale,
    DWORD dwFlags,
    LPCSTR lpValue,
    const NUMBERFMTA* lpFormat,   // optional
    LPSTR lpNumberStr,   // optional
    INT cchNumber
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern int GetNumberFormatA(
    uint Locale,   // DWORD
    uint dwFlags,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string lpValue,   // LPCSTR
    IntPtr lpFormat,   // NUMBERFMTA* optional
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpNumberStr,   // LPSTR optional, out
    int cchNumber   // INT
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetNumberFormatA(
    Locale As UInteger,   ' DWORD
    dwFlags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpValue As String,   ' LPCSTR
    lpFormat As IntPtr,   ' NUMBERFMTA* optional
    <MarshalAs(UnmanagedType.LPStr)> lpNumberStr As System.Text.StringBuilder,   ' LPSTR optional, out
    cchNumber As Integer   ' INT
) As Integer
End Function

' Locale : DWORD
' dwFlags : DWORD
' lpValue : LPCSTR
' lpFormat : NUMBERFMTA* optional
' lpNumberStr : LPSTR optional, out
' cchNumber : INT
Declare PtrSafe Function GetNumberFormatA Lib "kernel32" ( _
    ByVal Locale As Long, _
    ByVal dwFlags As Long, _
    ByVal lpValue As String, _
    ByVal lpFormat As LongPtr, _
    ByVal lpNumberStr As String, _
    ByVal cchNumber As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetNumberFormatA = ctypes.windll.kernel32.GetNumberFormatA
GetNumberFormatA.restype = ctypes.c_int
GetNumberFormatA.argtypes = [
    wintypes.DWORD,  # Locale : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.LPCSTR,  # lpValue : LPCSTR
    ctypes.c_void_p,  # lpFormat : NUMBERFMTA* optional
    wintypes.LPSTR,  # lpNumberStr : LPSTR optional, out
    ctypes.c_int,  # cchNumber : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetNumberFormatA = Fiddle::Function.new(
  lib['GetNumberFormatA'],
  [
    -Fiddle::TYPE_INT,  # Locale : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # lpValue : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpFormat : NUMBERFMTA* optional
    Fiddle::TYPE_VOIDP,  # lpNumberStr : LPSTR optional, out
    Fiddle::TYPE_INT,  # cchNumber : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetNumberFormatA(
        Locale: u32,  // DWORD
        dwFlags: u32,  // DWORD
        lpValue: *const u8,  // LPCSTR
        lpFormat: *const NUMBERFMTA,  // NUMBERFMTA* optional
        lpNumberStr: *mut u8,  // LPSTR optional, out
        cchNumber: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern int GetNumberFormatA(uint Locale, uint dwFlags, [MarshalAs(UnmanagedType.LPStr)] string lpValue, IntPtr lpFormat, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpNumberStr, int cchNumber);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetNumberFormatA' -Namespace Win32 -PassThru
# $api::GetNumberFormatA(Locale, dwFlags, lpValue, lpFormat, lpNumberStr, cchNumber)

#uselib "KERNEL32.dll"
#func global GetNumberFormatA "GetNumberFormatA" sptr, sptr, sptr, sptr, sptr, sptr
; GetNumberFormatA Locale, dwFlags, lpValue, varptr(lpFormat), varptr(lpNumberStr), cchNumber   ; 戻り値は stat
; Locale : DWORD -> "sptr"
; dwFlags : DWORD -> "sptr"
; lpValue : LPCSTR -> "sptr"
; lpFormat : NUMBERFMTA* optional -> "sptr"
; lpNumberStr : LPSTR optional, out -> "sptr"
; cchNumber : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetNumberFormatA "GetNumberFormatA" int, int, str, var, var, int
; res = GetNumberFormatA(Locale, dwFlags, lpValue, lpFormat, lpNumberStr, cchNumber)
; Locale : DWORD -> "int"
; dwFlags : DWORD -> "int"
; lpValue : LPCSTR -> "str"
; lpFormat : NUMBERFMTA* optional -> "var"
; lpNumberStr : LPSTR optional, out -> "var"
; cchNumber : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetNumberFormatA "GetNumberFormatA" int, int, str, sptr, sptr, int
; res = GetNumberFormatA(Locale, dwFlags, lpValue, varptr(lpFormat), varptr(lpNumberStr), cchNumber)
; Locale : DWORD -> "int"
; dwFlags : DWORD -> "int"
; lpValue : LPCSTR -> "str"
; lpFormat : NUMBERFMTA* optional -> "sptr"
; lpNumberStr : LPSTR optional, out -> "sptr"
; cchNumber : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。