ホーム › Globalization › GetCurrencyFormatA

GetCurrencyFormatA

関数

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

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

シグネチャ

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

INT GetCurrencyFormatA(
    DWORD Locale,
    DWORD dwFlags,
    LPCSTR lpValue,
    const CURRENCYFMTA* lpFormat,   // optional
    LPSTR lpCurrencyStr,   // optional
    INT cchCurrency
);

パラメーター

名前	型	方向	説明
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	詳細については、GetCurrencyFormatEx の lpValue パラメーターを参照してください。
lpFormat	CURRENCYFMTA*	inoptional	通貨の書式設定情報を格納する CURRENCYFMT 構造体へのポインターです。構造体のすべてのメンバーには適切な値を格納する必要があります。関数が指定されたロケールの通貨書式を使用する場合、アプリケーションはこのパラメーターを NULL に設定できます。このパラメーターが NULL に設定されていない場合、関数は CURRENCYFMT 構造体で指定されていない書式設定情報(たとえばロケールで使用される負符号の文字列値など)に対してのみ、指定されたロケールを使用します。
lpCurrencyStr	LPSTR	outoptional	この関数が書式設定済みの通貨文字列を取得するバッファーへのポインターです。
cchCurrency	INT	in	lpCurrencyStr バッファーのサイズ(文字数単位)です。書式設定済みの通貨文字列を格納するために必要なバッファーのサイズを関数に返させる場合、アプリケーションはこのパラメーターを 0 に設定します。この場合、lpCurrencyStr パラメーターは使用されません。

戻り値の型: INT

公式ドキュメント

数値文字列を、識別子で指定されたロケールの通貨文字列として書式設定します。(ANSI)

戻り値

成功した場合、lpCurrencyStr で示されるバッファーに取得された文字数を返します。cchCurrency パラメーターが 0 に設定されている場合、関数は終端の null 文字を含めて、書式設定済みの通貨文字列を格納するために必要なバッファーのサイズを返します。

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

ERROR_INSUFFICIENT_BUFFER。指定されたバッファーサイズが十分な大きさでなかったか、誤って NULL に設定されていました。
ERROR_INVALID_FLAGS。フラグに指定された値が無効でした。
ERROR_INVALID_PARAMETER。いずれかのパラメーター値が無効でした。

解説(Remarks)

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

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetCurrencyFormatA(
    DWORD Locale,
    DWORD dwFlags,
    LPCSTR lpValue,
    const CURRENCYFMTA* lpFormat,   // optional
    LPSTR lpCurrencyStr,   // optional
    INT cchCurrency
);

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

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetCurrencyFormatA = Fiddle::Function.new(
  lib['GetCurrencyFormatA'],
  [
    -Fiddle::TYPE_INT,  # Locale : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # lpValue : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpFormat : CURRENCYFMTA* optional
    Fiddle::TYPE_VOIDP,  # lpCurrencyStr : LPSTR optional, out
    Fiddle::TYPE_INT,  # cchCurrency : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetCurrencyFormatA(
        Locale: u32,  // DWORD
        dwFlags: u32,  // DWORD
        lpValue: *const u8,  // LPCSTR
        lpFormat: *const CURRENCYFMTA,  // CURRENCYFMTA* optional
        lpCurrencyStr: *mut u8,  // LPSTR optional, out
        cchCurrency: 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 GetCurrencyFormatA(uint Locale, uint dwFlags, [MarshalAs(UnmanagedType.LPStr)] string lpValue, IntPtr lpFormat, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpCurrencyStr, int cchCurrency);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetCurrencyFormatA' -Namespace Win32 -PassThru
# $api::GetCurrencyFormatA(Locale, dwFlags, lpValue, lpFormat, lpCurrencyStr, cchCurrency)

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

出力引数:

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