VarFormat

関数

書式文字列に従いVARIANT値を文字列に整形する。

DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

HRESULT VarFormat(
    VARIANT* pvarIn,
    LPWSTR pstrFormat,   // optional
    VARFORMAT_FIRST_DAY iFirstDay,
    VARFORMAT_FIRST_WEEK iFirstWeek,
    DWORD dwFlags,
    LPWSTR* pbstrOut
);

パラメーター

名前

型

方向

説明

pvarIn

VARIANT*

variant。

pstrFormat

LPWSTR

inoptional

書式文字列。たとえば "mm-dd-yy"。

iFirstDay

VARFORMAT_FIRST_DAY

週の最初の曜日。

値	意味
0	システム既定値
1	月曜日
2	火曜日
3	水曜日
4	木曜日
5	金曜日
6	土曜日
7	日曜日

iFirstWeek

VARFORMAT_FIRST_WEEK

年の最初の週。

値	意味
0	システム既定値。
1	1 月 1 日を含む週を最初の週とします。
2	最初の週の過半数 (4 日以上) が現在の年に含まれる週を最初の週とします。
3	7 日間すべてを含む最初の週を最初の週とします。

dwFlags

DWORD

書式設定処理を制御するフラグ。設定できるフラグは VAR_CALENDAR_HIJRI または VAR_FORMAT_NOSUBSTITUTE のみです。

pbstrOut

LPWSTR*

out

variant を表す書式設定された文字列。

戻り値の型: HRESULT

公式ドキュメント

書式文字列を解析して、variant を文字列形式に書式設定します。

戻り値

この関数は次のいずれかの値を返します。

戻り値	説明
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 VarFormat(
    VARIANT* pvarIn,
    LPWSTR pstrFormat,   // optional
    VARFORMAT_FIRST_DAY iFirstDay,
    VARFORMAT_FIRST_WEEK iFirstWeek,
    DWORD dwFlags,
    LPWSTR* pbstrOut
);

[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int VarFormat(
    IntPtr pvarIn,   // VARIANT*
    [MarshalAs(UnmanagedType.LPWStr)] string pstrFormat,   // LPWSTR optional
    int iFirstDay,   // VARFORMAT_FIRST_DAY
    int iFirstWeek,   // VARFORMAT_FIRST_WEEK
    uint dwFlags,   // DWORD
    IntPtr pbstrOut   // LPWSTR* out
);

<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function VarFormat(
    pvarIn As IntPtr,   ' VARIANT*
    <MarshalAs(UnmanagedType.LPWStr)> pstrFormat As String,   ' LPWSTR optional
    iFirstDay As Integer,   ' VARFORMAT_FIRST_DAY
    iFirstWeek As Integer,   ' VARFORMAT_FIRST_WEEK
    dwFlags As UInteger,   ' DWORD
    pbstrOut As IntPtr   ' LPWSTR* out
) As Integer
End Function

' pvarIn : VARIANT*
' pstrFormat : LPWSTR optional
' iFirstDay : VARFORMAT_FIRST_DAY
' iFirstWeek : VARFORMAT_FIRST_WEEK
' dwFlags : DWORD
' pbstrOut : LPWSTR* out
Declare PtrSafe Function VarFormat Lib "oleaut32" ( _
    ByVal pvarIn As LongPtr, _
    ByVal pstrFormat As LongPtr, _
    ByVal iFirstDay As Long, _
    ByVal iFirstWeek 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

VarFormat = ctypes.windll.oleaut32.VarFormat
VarFormat.restype = ctypes.c_int
VarFormat.argtypes = [
    ctypes.c_void_p,  # pvarIn : VARIANT*
    wintypes.LPCWSTR,  # pstrFormat : LPWSTR optional
    ctypes.c_int,  # iFirstDay : VARFORMAT_FIRST_DAY
    ctypes.c_int,  # iFirstWeek : VARFORMAT_FIRST_WEEK
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # pbstrOut : LPWSTR* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLEAUT32.dll')
VarFormat = Fiddle::Function.new(
  lib['VarFormat'],
  [
    Fiddle::TYPE_VOIDP,  # pvarIn : VARIANT*
    Fiddle::TYPE_VOIDP,  # pstrFormat : LPWSTR optional
    Fiddle::TYPE_INT,  # iFirstDay : VARFORMAT_FIRST_DAY
    Fiddle::TYPE_INT,  # iFirstWeek : VARFORMAT_FIRST_WEEK
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pbstrOut : LPWSTR* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "oleaut32")]
extern "system" {
    fn VarFormat(
        pvarIn: *mut VARIANT,  // VARIANT*
        pstrFormat: *mut u16,  // LPWSTR optional
        iFirstDay: i32,  // VARFORMAT_FIRST_DAY
        iFirstWeek: i32,  // VARFORMAT_FIRST_WEEK
        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 VarFormat(IntPtr pvarIn, [MarshalAs(UnmanagedType.LPWStr)] string pstrFormat, int iFirstDay, int iFirstWeek, uint dwFlags, IntPtr pbstrOut);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_VarFormat' -Namespace Win32 -PassThru
# $api::VarFormat(pvarIn, pstrFormat, iFirstDay, iFirstWeek, dwFlags, pbstrOut)

#uselib "OLEAUT32.dll"
#func global VarFormat "VarFormat" sptr, sptr, sptr, sptr, sptr, sptr
; VarFormat varptr(pvarIn), pstrFormat, iFirstDay, iFirstWeek, dwFlags, varptr(pbstrOut)   ; 戻り値は stat
; pvarIn : VARIANT* -> "sptr"
; pstrFormat : LPWSTR optional -> "sptr"
; iFirstDay : VARFORMAT_FIRST_DAY -> "sptr"
; iFirstWeek : VARFORMAT_FIRST_WEEK -> "sptr"
; dwFlags : DWORD -> "sptr"
; pbstrOut : LPWSTR* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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