GetNumberFormatEx

関数

ロケール名に従って数値を書式付き文字列に整形する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

INT GetNumberFormatEx(
    LPCWSTR lpLocaleName,   // optional
    DWORD dwFlags,
    LPCWSTR lpValue,
    const NUMBERFMTW* lpFormat,   // optional
    LPWSTR lpNumberStr,   // optional
    INT cchNumber
);

パラメーター

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

戻り値の型: INT

公式ドキュメント

数値文字列を、名前で指定されたロケール向けにカスタマイズされた数値文字列として書式設定します。注意 Windows Vista 以降でのみ実行されるよう設計されている場合、アプリケーションは GetNumberFormat よりもこの関数を優先して呼び出してください。注意この関数は、カスタムロケールなどの理由により、リリース間で変化するデータを書式設定できます。アプリケーションでデータを永続化または送信する必要がある場合は、「Using Persistent Locale Data」を参照してください。

戻り値

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

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

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

解説(Remarks)

Windows 8 以降: アプリが Windows.Globalization 名前空間の言語タグをこの関数に渡す場合、まず ResolveLocaleName を呼び出してタグを変換する必要があります。

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

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

INT GetNumberFormatEx(
    LPCWSTR lpLocaleName,   // optional
    DWORD dwFlags,
    LPCWSTR lpValue,
    const NUMBERFMTW* lpFormat,   // optional
    LPWSTR lpNumberStr,   // optional
    INT cchNumber
);

[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern int GetNumberFormatEx(
    [MarshalAs(UnmanagedType.LPWStr)] string lpLocaleName,   // LPCWSTR optional
    uint dwFlags,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string lpValue,   // LPCWSTR
    IntPtr lpFormat,   // NUMBERFMTW* optional
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpNumberStr,   // LPWSTR optional, out
    int cchNumber   // INT
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetNumberFormatEx(
    <MarshalAs(UnmanagedType.LPWStr)> lpLocaleName As String,   ' LPCWSTR optional
    dwFlags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpValue As String,   ' LPCWSTR
    lpFormat As IntPtr,   ' NUMBERFMTW* optional
    <MarshalAs(UnmanagedType.LPWStr)> lpNumberStr As System.Text.StringBuilder,   ' LPWSTR optional, out
    cchNumber As Integer   ' INT
) As Integer
End Function

' lpLocaleName : LPCWSTR optional
' dwFlags : DWORD
' lpValue : LPCWSTR
' lpFormat : NUMBERFMTW* optional
' lpNumberStr : LPWSTR optional, out
' cchNumber : INT
Declare PtrSafe Function GetNumberFormatEx Lib "kernel32" ( _
    ByVal lpLocaleName As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal lpValue As LongPtr, _
    ByVal lpFormat As LongPtr, _
    ByVal lpNumberStr As LongPtr, _
    ByVal cchNumber As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetNumberFormatEx = ctypes.windll.kernel32.GetNumberFormatEx
GetNumberFormatEx.restype = ctypes.c_int
GetNumberFormatEx.argtypes = [
    wintypes.LPCWSTR,  # lpLocaleName : LPCWSTR optional
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.LPCWSTR,  # lpValue : LPCWSTR
    ctypes.c_void_p,  # lpFormat : NUMBERFMTW* optional
    wintypes.LPWSTR,  # lpNumberStr : LPWSTR 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')
GetNumberFormatEx = Fiddle::Function.new(
  lib['GetNumberFormatEx'],
  [
    Fiddle::TYPE_VOIDP,  # lpLocaleName : LPCWSTR optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # lpValue : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpFormat : NUMBERFMTW* optional
    Fiddle::TYPE_VOIDP,  # lpNumberStr : LPWSTR optional, out
    Fiddle::TYPE_INT,  # cchNumber : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetNumberFormatEx(
        lpLocaleName: *const u16,  // LPCWSTR optional
        dwFlags: u32,  // DWORD
        lpValue: *const u16,  // LPCWSTR
        lpFormat: *const NUMBERFMTW,  // NUMBERFMTW* optional
        lpNumberStr: *mut u16,  // LPWSTR optional, out
        cchNumber: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

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

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

出力引数:

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