GetNumberFormatW

数値文字列を、識別子で指定したロケール用にカスタマイズした数値文字列としてフォーマットする。(Unicode)

GetNumberFormatW Locale, dwFlags, lpValue, lpFormat, lpNumberStr, cchNumber

Locale : [int] ロケールを指定するロケール識別子。MAKELCID マクロを使用してロケール識別子を作成するか、以下の定義済み値のいずれかを使用できる。
dwFlags : [int] 関数の動作を制御するフラグ。lpFormat が NULL に設定されていない場合、アプリケーションはこのパラメータを 0 に設定する必要がある。この場合、関数はロケールの既定の数値形式に対するユーザー上書きを使用して文字列をフォーマットする。lpFormat が NULL に設定されている場合、アプリケーションは LOCALE_NOUSEROVERRIDE を指定して、指定したロケールに対するシステム既定の数値形式で文字列をフォーマットできる。注意 LOCALE_NOUSEROVERRIDE の使用はユーザー設定を無効にするため、強く非推奨である。
lpValue : [wstr] フォーマット対象の数値文字列を含む null 終端文字列へのポインタ。この文字列は以下の文字のみを含むことができる。それ以外の文字はすべて無効である。lpValue が示す文字列がこれらの規則から逸脱している場合、関数はエラーを返す。
lpFormat : [var] 数値書式情報を含む NUMBERFMT 構造体へのポインタ。すべてのメンバが適切な値に設定されている必要がある。このパラメータが NULL に設定されていない場合、関数は構造体で指定されていない書式情報(たとえば負号のロケール固有文字列値)にのみロケールを使用する。
lpNumberStr : [wstr] この関数がフォーマット済み数値文字列を取得するバッファへのポインタ。
cchNumber : [int] lpNumberStr が示す数値文字列バッファのサイズ(TCHAR 単位)。アプリケーションはこのパラメータを 0 に設定することもできる。その場合、関数は数値文字列バッファに必要なサイズを返し、lpNumberStr パラメータを使用しない。

(プラグイン / モジュール : kernel32.dll)

解説

数値文字列を、識別子で指定したロケール用にカスタマイズした数値文字列としてフォーマットする。(Unicode)

[戻り値]
成功した場合、lpNumberStr が示すバッファに取得された TCHAR 値の数を返す。cchNumber パラメータが 0
に設定されている場合、関数はフォーマット済み数値文字列を保持するために必要な文字数(終端 null
文字を含む)を返す。成功しなかった場合、関数は 0 を返す。拡張エラー情報を取得するには、アプリケーションは GetLastError
を呼ぶ。これは以下のいずれかのエラーコードを返す。
(以下省略)

[備考]

この関数はカスタムロケールからデータを取得できる。データはコンピュータ間やアプリケーションの実行間で同じであることは保証されない。アプリケーションがデータを永続化または送信する必要がある場合は、Using
Persistent Locale Data を参照。Unicode 専用ロケール識別子と共にこの関数の ANSI
版を使用する場合、オペレーティングシステムがシステムコードページを使用するため関数は成功し得る。ただし、システムコードページで未定義の文字は文字列内で疑問符
(?) として現れる。
> [!NOTE] > winnls.h ヘッダは GetNumberFormat を、UNICODE プリプロセッサ定数の定義に基づいて
ANSI または Unicode
版を自動選択するエイリアスとして定義する。エンコーディング中立なエイリアスとそうでないコードを混在させると、コンパイルや実行時のエラーを引き起こす不一致が生じうる。詳細は
[Conventions for Function
Prototypes](/windows/win32/intl/conventions-for-function-prototypes)
を参照。

情報

プラグイン / モジュールkernel32.dll
バージョン1.0
作成日2026/04/16
著作者IronHSP / CsWin32 bridge
URLhttps://github.com/inovia/IronHSP
備考Win32 API の kernel32.dll 関数群。CsWin32 + win32metadata から自動生成。
hsp3net 専用 (intptr / NSTRUCT / wstr を使用)。
タイプ拡張命令
グループWin32API
対応環境
  • Windows 版 HSP
hs ファイルhsphelp\win32_kernel32_gen2.hs