VarFormatNumber

関数

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

DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

HRESULT VarFormatNumber(
    VARIANT* pvarIn,
    INT iNumDig,
    VARFORMAT_LEADING_DIGIT iIncLead,
    VARFORMAT_PARENTHESES iUseParens,
    VARFORMAT_GROUP iGroup,
    DWORD dwFlags,
    LPWSTR* pbstrOut
);

パラメーター

名前

型

方向

説明

pvarIn

VARIANT*

整形する値を格納した variant。

iNumDig

INT

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

iIncLead

VARFORMAT_LEADING_DIGIT

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

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

iUseParens

VARFORMAT_PARENTHESES

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

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

iGroup

VARFORMAT_GROUP

千単位で桁区切りを行うかどうかを指定します。たとえば 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 VarFormatNumber(
    VARIANT* pvarIn,
    INT iNumDig,
    VARFORMAT_LEADING_DIGIT iIncLead,
    VARFORMAT_PARENTHESES iUseParens,
    VARFORMAT_GROUP iGroup,
    DWORD dwFlags,
    LPWSTR* pbstrOut
);

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

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

' pvarIn : VARIANT*
' iNumDig : INT
' iIncLead : VARFORMAT_LEADING_DIGIT
' iUseParens : VARFORMAT_PARENTHESES
' iGroup : VARFORMAT_GROUP
' dwFlags : DWORD
' pbstrOut : LPWSTR* out
Declare PtrSafe Function VarFormatNumber 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

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

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "oleaut32")]
extern "system" {
    fn VarFormatNumber(
        pvarIn: *mut VARIANT,  // VARIANT*
        iNumDig: i32,  // INT
        iIncLead: i32,  // VARFORMAT_LEADING_DIGIT
        iUseParens: i32,  // VARFORMAT_PARENTHESES
        iGroup: i32,  // VARFORMAT_GROUP
        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 VarFormatNumber(IntPtr pvarIn, int iNumDig, int iIncLead, int iUseParens, int iGroup, uint dwFlags, IntPtr pbstrOut);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_VarFormatNumber' -Namespace Win32 -PassThru
# $api::VarFormatNumber(pvarIn, iNumDig, iIncLead, iUseParens, iGroup, dwFlags, pbstrOut)

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

出力引数:

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