VarFormatDateTime

関数

VARIANT値を日付時刻形式の文字列に整形する。

DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

HRESULT VarFormatDateTime(
    VARIANT* pvarIn,
    VARFORMAT_NAMED_FORMAT iNamedFormat,
    DWORD dwFlags,
    LPWSTR* pbstrOut
);

パラメーター

名前

型

方向

説明

pvarIn

VARIANT*

書式設定する値を含む variant。

iNamedFormat

VARFORMAT_NAMED_FORMAT

名前付きの日付書式は次のとおりです。

値	意味
0	標準の日付
1	長い形式の日付
2	短い形式の日付
3	長い形式の時刻
4	短い形式の時刻

dwFlags

DWORD

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

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 VarFormatDateTime(
    VARIANT* pvarIn,
    VARFORMAT_NAMED_FORMAT iNamedFormat,
    DWORD dwFlags,
    LPWSTR* pbstrOut
);

[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int VarFormatDateTime(
    IntPtr pvarIn,   // VARIANT*
    int iNamedFormat,   // VARFORMAT_NAMED_FORMAT
    uint dwFlags,   // DWORD
    IntPtr pbstrOut   // LPWSTR* out
);

<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function VarFormatDateTime(
    pvarIn As IntPtr,   ' VARIANT*
    iNamedFormat As Integer,   ' VARFORMAT_NAMED_FORMAT
    dwFlags As UInteger,   ' DWORD
    pbstrOut As IntPtr   ' LPWSTR* out
) As Integer
End Function

' pvarIn : VARIANT*
' iNamedFormat : VARFORMAT_NAMED_FORMAT
' dwFlags : DWORD
' pbstrOut : LPWSTR* out
Declare PtrSafe Function VarFormatDateTime Lib "oleaut32" ( _
    ByVal pvarIn As LongPtr, _
    ByVal iNamedFormat 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

VarFormatDateTime = ctypes.windll.oleaut32.VarFormatDateTime
VarFormatDateTime.restype = ctypes.c_int
VarFormatDateTime.argtypes = [
    ctypes.c_void_p,  # pvarIn : VARIANT*
    ctypes.c_int,  # iNamedFormat : VARFORMAT_NAMED_FORMAT
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # pbstrOut : LPWSTR* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLEAUT32.dll')
VarFormatDateTime = Fiddle::Function.new(
  lib['VarFormatDateTime'],
  [
    Fiddle::TYPE_VOIDP,  # pvarIn : VARIANT*
    Fiddle::TYPE_INT,  # iNamedFormat : VARFORMAT_NAMED_FORMAT
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pbstrOut : LPWSTR* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "oleaut32")]
extern "system" {
    fn VarFormatDateTime(
        pvarIn: *mut VARIANT,  // VARIANT*
        iNamedFormat: i32,  // VARFORMAT_NAMED_FORMAT
        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 VarFormatDateTime(IntPtr pvarIn, int iNamedFormat, uint dwFlags, IntPtr pbstrOut);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_VarFormatDateTime' -Namespace Win32 -PassThru
# $api::VarFormatDateTime(pvarIn, iNamedFormat, dwFlags, pbstrOut)

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

出力引数:

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