<Return[G]><Top>

GetCurrencyFormat

Declare Function Api_GetCurrencyFormat& Lib "kernel32" Alias "GetCurrencyFormatA" (ByVal Locale&, ByVal dwFlags&, ByVal lpValue$, lpFormat As Any, ByVal lpCurrencyStr$, ByVal cchCurrency&)

Declare Function GetCurrencyFormat Lib "kernel32" Alias "GetCurrencyFormatA" (ByVal Locale As Long, ByVal dwFlags As Long, ByVal lpValue As String, lpFormat As CURRENCYFMT, ByVal lpCurrencyStr As String, ByVal cchCurrency As Long) As Long

数字文字列を、指定したロケールの通貨文字列として書式化する。

パラメータ
Locale
    通貨文字列の書式化に使うロケールを指定する。

    NULL を指定すると、現在のロケールの通貨形式に従って文字列が書式化される。

    lpFormat に NULL 以外を指定すると、CURRENCYFMT 構造体で指定されない書式化情報(たとえば、マイナス記号に対応する

    ロケールの文字列値)に限り、指定したロケールが使われる。

    値                                               

意味                            

    LOCALE_SYSTEM_DEFAULT

既定のシステムロケール

    LOCALE_USER_DEFAULT

既定のユーザーロケール

dwFlags
    関数の動作を制御するビットフラグをセットする。

    lpFormat パラメータに NULL 以外の値を指定するときは、このパラメータに 0 を指定する。
    lpFormat に NULL を指定するときは、LOCALE_NOUSEROVERRIDE フラグをセットし、Locale パラメータで指定するロケールの

    システム既定通貨形式を使って文字列を書式化できる。

    また、dwFlags パラメータに 0 を指定すると、ロケールの既定通貨形式にユーザーが上書きした内容を使って文字列が書式化される。
lpValue
    書式化する数字を表す、NULL で終わる文字列へのポインタを指定する。
    次の文字が使る。
        0 から 9 までの文字
        浮動小数点数の場合は 1 つの小数点
        負の数の場合は先頭の文字位置にマイナス符号
        他の文字はすべて無効でである。lpValue パラメータが指す文字列がこの規則に従っていないと、関数はエラーを返す。
lpFormat
    通貨書式化情報が入った CURRENCYFMT 構造体へのポインタを指定する。

    lpFormat パラメータが指す構造体のすべてのメンバに、該当する値を入れておく。
    lpFormat パラメータに NULL を指定すると、指定したロケールの通貨形式が使われる。
lpCurrencyStr
    書式化した通貨文字列を受け取るバッファへのポインタを指定する。
cchCurrency
    lpCurrencyStr パラメータが指すバッファのサイズを、バイト単位(ANSI 版)、または文字単位(Unicode 版)で指定する。

    0 を指定すると、書式化した通貨文字列を格納するのに必要なバイト数、または文字数が返る。

    この場合、lpCurrencyStr パラメータが指すバッファは使われない。

 
戻り値
    関数が成功すると、lpCurrencyStr パラメータが指すバッファに書き込まれたバイト数(ANSI 版)、または文字数(Unicode 版)が

    返る。cchCurrency パラメータに 0 を指定したときは、書式化した通貨文字列を保持するために必要なバイト数、または文字数が返る。
    関数が失敗すると、0 が返る。拡張エラー情報を取得するには、GetLastError 関数を使います。GetLastError 関数は、次のいずれか

    のエラーコードを返す。
    ERROR_INSUFFICIENT_BUFFER
    ERROR_INVALID FLAGS
    ERROR_INVALID_PARAMETER