Win32 API 日本語リファレンス
ホームSystem.Ole › VarFormat

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
);

パラメーター

名前方向
pvarInVARIANT*in
pstrFormatLPWSTRinoptional
iFirstDayVARFORMAT_FIRST_DAYin
iFirstWeekVARFORMAT_FIRST_WEEKin
dwFlagsDWORDin
pbstrOutLPWSTR*out

戻り値の型: HRESULT

各言語での呼び出し定義

// 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 方式にも切替可。
出力引数:
; HRESULT VarFormat(VARIANT* pvarIn, LPWSTR pstrFormat, VARFORMAT_FIRST_DAY iFirstDay, VARFORMAT_FIRST_WEEK iFirstWeek, DWORD dwFlags, LPWSTR* pbstrOut)
#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 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
	procVarFormat = oleaut32.NewProc("VarFormat")
)

// pvarIn (VARIANT*), pstrFormat (LPWSTR optional), iFirstDay (VARFORMAT_FIRST_DAY), iFirstWeek (VARFORMAT_FIRST_WEEK), dwFlags (DWORD), pbstrOut (LPWSTR* out)
r1, _, err := procVarFormat.Call(
	uintptr(pvarIn),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pstrFormat))),
	uintptr(iFirstDay),
	uintptr(iFirstWeek),
	uintptr(dwFlags),
	uintptr(pbstrOut),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function VarFormat(
  pvarIn: Pointer;   // VARIANT*
  pstrFormat: PWideChar;   // LPWSTR optional
  iFirstDay: Integer;   // VARFORMAT_FIRST_DAY
  iFirstWeek: Integer;   // VARFORMAT_FIRST_WEEK
  dwFlags: DWORD;   // DWORD
  pbstrOut: PPWideChar   // LPWSTR* out
): Integer; stdcall;
  external 'OLEAUT32.dll' name 'VarFormat';
result := DllCall("OLEAUT32\VarFormat"
    , "Ptr", pvarIn   ; VARIANT*
    , "WStr", pstrFormat   ; LPWSTR optional
    , "Int", iFirstDay   ; VARFORMAT_FIRST_DAY
    , "Int", iFirstWeek   ; VARFORMAT_FIRST_WEEK
    , "UInt", dwFlags   ; DWORD
    , "Ptr", pbstrOut   ; LPWSTR* out
    , "Int")   ; return: HRESULT
●VarFormat(pvarIn, pstrFormat, iFirstDay, iFirstWeek, dwFlags, pbstrOut) = DLL("OLEAUT32.dll", "int VarFormat(void*, char*, int, int, dword, void*)")
# 呼び出し: VarFormat(pvarIn, pstrFormat, iFirstDay, iFirstWeek, dwFlags, pbstrOut)
# pvarIn : VARIANT* -> "void*"
# pstrFormat : LPWSTR optional -> "char*"
# iFirstDay : VARFORMAT_FIRST_DAY -> "int"
# iFirstWeek : VARFORMAT_FIRST_WEEK -> "int"
# dwFlags : DWORD -> "dword"
# pbstrOut : LPWSTR* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。