ホーム › Globalization › GetCurrencyFormatW

GetCurrencyFormatW

関数

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

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

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

INT GetCurrencyFormatW(
    DWORD Locale,
    DWORD dwFlags,
    LPCWSTR lpValue,
    const CURRENCYFMTW* lpFormat,   // optional
    LPWSTR 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	LPCWSTR	in	詳細については、GetCurrencyFormatEx の lpValue パラメーターを参照してください。
lpFormat	CURRENCYFMTW*	inoptional	通貨の書式設定情報を格納する CURRENCYFMT 構造体へのポインターです。構造体のすべてのメンバーには適切な値を格納する必要があります。指定したロケールの通貨書式を使用する場合、アプリケーションはこのパラメーターを NULL に設定できます。このパラメーターを NULL 以外に設定した場合、関数は CURRENCYFMT 構造体で指定されていない書式設定情報(例えば、ロケールで使用される負符号の文字列値)についてのみ、指定したロケールを使用します。
lpCurrencyStr	LPWSTR	outoptional	この関数が書式設定された通貨文字列を取得するバッファーへのポインターです。
cchCurrency	INT	in	lpCurrencyStr バッファーのサイズ(文字数)です。書式設定された通貨文字列を格納するために必要なバッファーのサイズを関数から返させる場合、アプリケーションはこのパラメーターを 0 に設定します。この場合、lpCurrencyStr パラメーターは使用されません。

戻り値の型: INT

公式ドキュメント

指定したロケール識別子に対応するロケール用に、数値文字列を通貨文字列として書式設定します。(Unicode)

戻り値

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

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

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

解説(Remarks)

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

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

メモ

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

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

各言語での呼び出し定義

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

INT GetCurrencyFormatW(
    DWORD Locale,
    DWORD dwFlags,
    LPCWSTR lpValue,
    const CURRENCYFMTW* lpFormat,   // optional
    LPWSTR lpCurrencyStr,   // optional
    INT cchCurrency
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern int GetCurrencyFormatW(
    uint Locale,   // DWORD
    uint dwFlags,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string lpValue,   // LPCWSTR
    IntPtr lpFormat,   // CURRENCYFMTW* optional
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpCurrencyStr,   // LPWSTR optional, out
    int cchCurrency   // INT
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetCurrencyFormatW(
    Locale As UInteger,   ' DWORD
    dwFlags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpValue As String,   ' LPCWSTR
    lpFormat As IntPtr,   ' CURRENCYFMTW* optional
    <MarshalAs(UnmanagedType.LPWStr)> lpCurrencyStr As System.Text.StringBuilder,   ' LPWSTR optional, out
    cchCurrency As Integer   ' INT
) As Integer
End Function

' Locale : DWORD
' dwFlags : DWORD
' lpValue : LPCWSTR
' lpFormat : CURRENCYFMTW* optional
' lpCurrencyStr : LPWSTR optional, out
' cchCurrency : INT
Declare PtrSafe Function GetCurrencyFormatW Lib "kernel32" ( _
    ByVal Locale As Long, _
    ByVal dwFlags As Long, _
    ByVal lpValue As LongPtr, _
    ByVal lpFormat As LongPtr, _
    ByVal lpCurrencyStr As LongPtr, _
    ByVal cchCurrency As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetCurrencyFormatW = ctypes.windll.kernel32.GetCurrencyFormatW
GetCurrencyFormatW.restype = ctypes.c_int
GetCurrencyFormatW.argtypes = [
    wintypes.DWORD,  # Locale : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.LPCWSTR,  # lpValue : LPCWSTR
    ctypes.c_void_p,  # lpFormat : CURRENCYFMTW* optional
    wintypes.LPWSTR,  # lpCurrencyStr : LPWSTR 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')
GetCurrencyFormatW = Fiddle::Function.new(
  lib['GetCurrencyFormatW'],
  [
    -Fiddle::TYPE_INT,  # Locale : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # lpValue : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpFormat : CURRENCYFMTW* optional
    Fiddle::TYPE_VOIDP,  # lpCurrencyStr : LPWSTR optional, out
    Fiddle::TYPE_INT,  # cchCurrency : INT
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern int GetCurrencyFormatW(uint Locale, uint dwFlags, [MarshalAs(UnmanagedType.LPWStr)] string lpValue, IntPtr lpFormat, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpCurrencyStr, int cchCurrency);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetCurrencyFormatW' -Namespace Win32 -PassThru
# $api::GetCurrencyFormatW(Locale, dwFlags, lpValue, lpFormat, lpCurrencyStr, cchCurrency)

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

出力引数:

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