VarDateFromUdate

関数

UDATE構造体をDATE型の日付値に変換する。

DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

HRESULT VarDateFromUdate(
    UDATE* pudateIn,
    DWORD dwFlags,
    DOUBLE* pdateOut
);

パラメーター

名前	型	方向	説明
pudateIn	UDATE*	in	アンパックされた日付。
dwFlags	DWORD	in	日付が有効な場合は VAR_VALIDDATE。
pdateOut	DOUBLE*	out	パックされた日付。

戻り値の型: HRESULT

公式ドキュメント

MS-DOS 形式から変換された時刻と日付を variant 形式に変換します。(VarDateFromUdate)

戻り値

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

戻り値	説明
S_OK	成功。
E_INVALIDARG	引数のいずれかが無効です。
E_OUTOFMEMORY	操作を完了するためのメモリが不足しています。

解説(Remarks)

UDATE 構造体は VarDateFromUdate、VarDateFromUdateEx、および VarUdateFromDate で使用されます。これはアンパックされた日付を表します。

typedef struct {
    SYSTEMTIME st;
    USHORT  wDayOfYear;
} UDATE;

VarDateFromUdate 関数は無効な日付を受け入れ、VARIANT 時刻に解決する際にそれらを修正しようとします。たとえば、2/29/2001 のような無効な日付は 3/1/2001 に解決されます。修正されるのは日のみであるため、無効な月の値はエラーの返却につながります。日は 1 から 31 の範囲にあるかどうかが検査されます。負の日や 31 を超える日はエラーになります。31 未満であってもその月の最大日を超える日は、翌月の該当する日に繰り上げられます。0 に等しい日は前月の末日として解決されます。たとえば、2/0/2001 のような無効な日付は 1/31/2001 に解決されます。

VarDateFromUdate の呼び出しは、LCID 0x0409 を指定して VarDateFromUdateEx を呼び出した場合と同じ効果を持ちます。

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

各言語での呼び出し定義

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

HRESULT VarDateFromUdate(
    UDATE* pudateIn,
    DWORD dwFlags,
    DOUBLE* pdateOut
);

[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int VarDateFromUdate(
    IntPtr pudateIn,   // UDATE*
    uint dwFlags,   // DWORD
    out double pdateOut   // DOUBLE* out
);

<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function VarDateFromUdate(
    pudateIn As IntPtr,   ' UDATE*
    dwFlags As UInteger,   ' DWORD
    <Out> ByRef pdateOut As Double   ' DOUBLE* out
) As Integer
End Function

' pudateIn : UDATE*
' dwFlags : DWORD
' pdateOut : DOUBLE* out
Declare PtrSafe Function VarDateFromUdate Lib "oleaut32" ( _
    ByVal pudateIn As LongPtr, _
    ByVal dwFlags As Long, _
    ByRef pdateOut As Double) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

VarDateFromUdate = ctypes.windll.oleaut32.VarDateFromUdate
VarDateFromUdate.restype = ctypes.c_int
VarDateFromUdate.argtypes = [
    ctypes.c_void_p,  # pudateIn : UDATE*
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.POINTER(ctypes.c_double),  # pdateOut : DOUBLE* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLEAUT32.dll')
VarDateFromUdate = Fiddle::Function.new(
  lib['VarDateFromUdate'],
  [
    Fiddle::TYPE_VOIDP,  # pudateIn : UDATE*
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pdateOut : DOUBLE* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "oleaut32")]
extern "system" {
    fn VarDateFromUdate(
        pudateIn: *mut UDATE,  // UDATE*
        dwFlags: u32,  // DWORD
        pdateOut: *mut f64  // DOUBLE* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLEAUT32.dll")]
public static extern int VarDateFromUdate(IntPtr pudateIn, uint dwFlags, out double pdateOut);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_VarDateFromUdate' -Namespace Win32 -PassThru
# $api::VarDateFromUdate(pudateIn, dwFlags, pdateOut)

#uselib "OLEAUT32.dll"
#func global VarDateFromUdate "VarDateFromUdate" sptr, sptr, sptr
; VarDateFromUdate varptr(pudateIn), dwFlags, varptr(pdateOut)   ; 戻り値は stat
; pudateIn : UDATE* -> "sptr"
; dwFlags : DWORD -> "sptr"
; pdateOut : DOUBLE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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