GetCurrencyFormatW

識別子で指定したロケール用に数値文字列を通貨文字列として整形する。(Unicode)

GetCurrencyFormatW Locale, dwFlags, lpValue, lpFormat, lpCurrencyStr, cchCurrency

Locale : [int] 通貨文字列を整形するロケールを指定するロケール識別子。MAKELCID マクロでロケール識別子を作成することも、次の定義済み値のいずれかを使うこともできる。
dwFlags : [int] 通貨書式を制御するフラグ。lpFormat が NULL でない場合、アプリケーションはこのパラメータを 0 に設定する必要がある。この場合、関数はロケールの既定の通貨形式に対するユーザーオーバーライドを使って文字列を整形する。lpFormat が NULL の場合、アプリケーションは LOCALE_NOUSEROVERRIDE を指定して、指定したロケールのシステム既定通貨形式を使って文字列を整形できる。注意: LOCALE_NOUSEROVERRIDE の使用はユーザー設定を無効にするため、強く推奨されない。
lpValue : [wstr] 詳細は GetCurrencyFormatEx の lpValue パラメータを参照。
lpFormat : [var] 通貨書式情報を含む CURRENCYFMT 構造体へのポインタ。構造体のすべてのメンバには適切な値が含まれていなければならない。指定したロケールの通貨形式を関数に使わせる場合、アプリケーションはこのパラメータを NULL に設定できる。このパラメータが NULL でない場合、関数は CURRENCYFMT 構造体で指定されていない書式情報(たとえばロケールで使われる負号の文字列値)に対してのみ指定したロケールを使う。
lpCurrencyStr : [wstr] 整形済み通貨文字列をこの関数が取得するバッファへのポインタ。
cchCurrency : [int] lpCurrencyStr バッファのサイズ。文字数で指定する。整形済み通貨文字列を保持するのに必要なバッファサイズを関数に返させる場合、アプリケーションはこのパラメータを 0 に設定する。この場合、lpCurrencyStr パラメータは使われない。

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

解説

識別子で指定したロケール用に数値文字列を通貨文字列として整形する。(Unicode)

[戻り値]
成功した場合、lpCurrencyStr が示すバッファに取得された文字数を返す。cchCurrency パラメータが 0
に設定されている場合、関数は終端 NULL 文字を含む整形済み通貨文字列を保持するのに必要なバッファサイズを返す。成功しなかった場合は 0
を返す。拡張エラー情報を取得するには GetLastError を呼び出すことができ、次のいずれかのエラーコードが返ることがある。
(以下省略)

[備考]

この関数はカスタムロケールからデータを取得することがある。データはコンピュータ間でもアプリケーションの実行間でも同じであることは保証されない。アプリケーションがデータを永続化または送信する必要がある場合は
Using Persistent Locale Data を参照。この関数の ANSI 版を Unicode
専用ロケール識別子と共に使った場合、OS
がシステムコードページを使うため呼び出しが成功することがある。ただし、システムコードページで未定義の文字は文字列中で疑問符(?)として表示される。
> [!NOTE] > winnls.h ヘッダでは GetCurrencyFormat が、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