VarFormatCurrency

関数

VARIANT値を通貨書式の文字列に整形する。

DLLOLEAUT32.dll呼出規約winapi

シグネチャ

// OLEAUT32.dll
#include <windows.h>

HRESULT VarFormatCurrency(
    VARIANT* pvarIn,
    INT iNumDig,
    INT iIncLead,
    INT iUseParens,
    INT iGroup,
    DWORD dwFlags,
    LPWSTR* pbstrOut
);

パラメーター

名前

型

方向

説明

pvarIn

VARIANT*

variant です。

iNumDig

INT

小数点以下を埋める桁数です。システムの既定値を使用するには -1 を指定します。

iIncLead

INT

数値に先頭の桁を含めるかどうかを指定します。

Value	Meaning
-2	システムの既定値を使用します。
-1	先頭の桁を含めます。
0	先頭の桁を含めません。

iUseParens

INT

負の数に括弧を使用するかどうかを指定します。

Value	Meaning
-2	システムの既定値を使用します。
-1	括弧を使用します。
0	括弧を使用しません。

iGroup

INT

千の位を桁区切りでグループ化するかどうかを指定します。たとえば 10000 に対する 10,000 です。

Note 通常の数値と通貨では、上記のすべてのオプションについて別々のシステム既定値があります。

Value	Meaning
-2	システムの既定値を使用します。
-1	千の位をグループ化します。
0	千の位をグループ化しません。

dwFlags

DWORD

設定できるフラグは VAR_CALENDAR_HIJRI のみです。

pbstrOut

LPWSTR*

out

variant を表す整形済みの文字列です。

戻り値の型: HRESULT

公式ドキュメント

通貨値を含む variant を文字列形式に整形します。

戻り値

この関数は次のいずれかの値を返すことがあります。

Return code	Description
S_OK	成功しました。
E_INVALIDARG	1 つ以上の引数が無効です。

解説(Remarks)

この関数は、VarTokenizeFormatString および VarFormatFromTokens を呼び出す際に、ユーザーの既定のロケールを使用します。

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

各言語での呼び出し定義

// OLEAUT32.dll
#include <windows.h>

HRESULT VarFormatCurrency(
    VARIANT* pvarIn,
    INT iNumDig,
    INT iIncLead,
    INT iUseParens,
    INT iGroup,
    DWORD dwFlags,
    LPWSTR* pbstrOut
);

[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int VarFormatCurrency(
    IntPtr pvarIn,   // VARIANT*
    int iNumDig,   // INT
    int iIncLead,   // INT
    int iUseParens,   // INT
    int iGroup,   // INT
    uint dwFlags,   // DWORD
    IntPtr pbstrOut   // LPWSTR* out
);

<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function VarFormatCurrency(
    pvarIn As IntPtr,   ' VARIANT*
    iNumDig As Integer,   ' INT
    iIncLead As Integer,   ' INT
    iUseParens As Integer,   ' INT
    iGroup As Integer,   ' INT
    dwFlags As UInteger,   ' DWORD
    pbstrOut As IntPtr   ' LPWSTR* out
) As Integer
End Function

' pvarIn : VARIANT*
' iNumDig : INT
' iIncLead : INT
' iUseParens : INT
' iGroup : INT
' dwFlags : DWORD
' pbstrOut : LPWSTR* out
Declare PtrSafe Function VarFormatCurrency Lib "oleaut32" ( _
    ByVal pvarIn As LongPtr, _
    ByVal iNumDig As Long, _
    ByVal iIncLead As Long, _
    ByVal iUseParens As Long, _
    ByVal iGroup As Long, _
    ByVal dwFlags As Long, _
    ByVal pbstrOut As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

VarFormatCurrency = ctypes.windll.oleaut32.VarFormatCurrency
VarFormatCurrency.restype = ctypes.c_int
VarFormatCurrency.argtypes = [
    ctypes.c_void_p,  # pvarIn : VARIANT*
    ctypes.c_int,  # iNumDig : INT
    ctypes.c_int,  # iIncLead : INT
    ctypes.c_int,  # iUseParens : INT
    ctypes.c_int,  # iGroup : INT
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # pbstrOut : LPWSTR* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLEAUT32.dll')
VarFormatCurrency = Fiddle::Function.new(
  lib['VarFormatCurrency'],
  [
    Fiddle::TYPE_VOIDP,  # pvarIn : VARIANT*
    Fiddle::TYPE_INT,  # iNumDig : INT
    Fiddle::TYPE_INT,  # iIncLead : INT
    Fiddle::TYPE_INT,  # iUseParens : INT
    Fiddle::TYPE_INT,  # iGroup : INT
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pbstrOut : LPWSTR* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "oleaut32")]
extern "system" {
    fn VarFormatCurrency(
        pvarIn: *mut VARIANT,  // VARIANT*
        iNumDig: i32,  // INT
        iIncLead: i32,  // INT
        iUseParens: i32,  // INT
        iGroup: i32,  // INT
        dwFlags: u32,  // DWORD
        pbstrOut: *mut *mut u16  // LPWSTR* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLEAUT32.dll")]
public static extern int VarFormatCurrency(IntPtr pvarIn, int iNumDig, int iIncLead, int iUseParens, int iGroup, uint dwFlags, IntPtr pbstrOut);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_VarFormatCurrency' -Namespace Win32 -PassThru
# $api::VarFormatCurrency(pvarIn, iNumDig, iIncLead, iUseParens, iGroup, dwFlags, pbstrOut)

#uselib "OLEAUT32.dll"
#func global VarFormatCurrency "VarFormatCurrency" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; VarFormatCurrency varptr(pvarIn), iNumDig, iIncLead, iUseParens, iGroup, dwFlags, varptr(pbstrOut)   ; 戻り値は stat
; pvarIn : VARIANT* -> "sptr"
; iNumDig : INT -> "sptr"
; iIncLead : INT -> "sptr"
; iUseParens : INT -> "sptr"
; iGroup : INT -> "sptr"
; dwFlags : DWORD -> "sptr"
; pbstrOut : LPWSTR* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "OLEAUT32.dll"
#cfunc global VarFormatCurrency "VarFormatCurrency" var, int, int, int, int, int, var
; res = VarFormatCurrency(pvarIn, iNumDig, iIncLead, iUseParens, iGroup, dwFlags, pbstrOut)
; pvarIn : VARIANT* -> "var"
; iNumDig : INT -> "int"
; iIncLead : INT -> "int"
; iUseParens : INT -> "int"
; iGroup : INT -> "int"
; dwFlags : DWORD -> "int"
; pbstrOut : LPWSTR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLEAUT32.dll"
#cfunc global VarFormatCurrency "VarFormatCurrency" sptr, int, int, int, int, int, sptr
; res = VarFormatCurrency(varptr(pvarIn), iNumDig, iIncLead, iUseParens, iGroup, dwFlags, varptr(pbstrOut))
; pvarIn : VARIANT* -> "sptr"
; iNumDig : INT -> "int"
; iIncLead : INT -> "int"
; iUseParens : INT -> "int"
; iGroup : INT -> "int"
; dwFlags : DWORD -> "int"
; pbstrOut : LPWSTR* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。