Win32 API 日本語リファレンス
ホームGlobalization › GetDateFormatEx

GetDateFormatEx

関数
ロケール名と暦を指定して日付を文字列へ整形する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

INT GetDateFormatEx(
    LPCWSTR lpLocaleName,   // optional
    ENUM_DATE_FORMATS_FLAGS dwFlags,
    const SYSTEMTIME* lpDate,   // optional
    LPCWSTR lpFormat,   // optional
    LPWSTR lpDateStr,   // optional
    INT cchDate,
    LPCWSTR lpCalendar   // optional
);

パラメーター

名前方向説明
lpLocaleNameLPCWSTRinoptional

ロケール名、または次の定義済み値のいずれかへのポインターです。

dwFlagsENUM_DATE_FORMATS_FLAGSin

lpFormatNULL に設定されている場合に指定できる、さまざまな関数オプションを指定するフラグです。アプリケーションは、次の値の組み合わせと、LOCALE_USE_CP_ACP または LOCALE_NOUSEROVERRIDE を指定できます。

注意 LOCALE_NOUSEROVERRIDE の使用は、ユーザー設定を無効にするため、強く推奨されません。
意味
DATE_AUTOLAYOUT
Windows 7 以降: ロケールとカレンダーの情報を使用して右から左および左から右への読み取りレイアウトの必要性を検出し、それに応じてマークを追加します。この値は DATE_LTRREADING または DATE_RTLREADING と一緒に使用できません。DATE_AUTOLAYOUT は、ロケールとカレンダーを使用してマークの正しい追加を判断するため、DATE_LTRREADING および DATE_RTLREADING よりも推奨されます。
DATE_LONGDATE
長い日付形式を使用します。この値は DATE_MONTHDAYDATE_SHORTDATE、または DATE_YEARMONTH と一緒に使用できません。
DATE_LTRREADING
左から右への読み取りレイアウト用のマークを追加します。この値は DATE_RTLREADING と一緒に使用できません。
DATE_RTLREADING
右から左への読み取りレイアウト用のマークを追加します。この値は DATE_LTRREADING と一緒に使用できません。
DATE_SHORTDATE
短い日付形式を使用します。これが既定値です。この値は DATE_MONTHDAYDATE_LONGDATE、または DATE_YEARMONTH と一緒に使用できません。
DATE_USE_ALT_CALENDAR
代替カレンダーが存在する場合は、それを使用して日付文字列を書式設定します。このフラグが設定されている場合、関数はユーザーオーバーライドを使用せず、その代替カレンダーの既定の形式を使用します。ユーザーオーバーライドは、指定された代替カレンダーに既定の形式が存在しない場合にのみ使用されます。
DATE_YEARMONTH
Windows Vista: 年/月形式を使用します。この値は DATE_MONTHDAYDATE_SHORTDATE、または DATE_LONGDATE と一緒に使用できません。
DATE_MONTHDAY
Windows 10: 指定されたロケールに適した月と日の形式の組み合わせを使用します。この値は DATE_YEARMONTHDATE_SHORTDATE、または DATE_LONGDATE と一緒に使用できません。

アプリケーションが DATE_YEARMONTHDATE_MONTHDAYDATE_SHORTDATE、または DATE_LONGDATE を指定せず、かつ lpFormatNULL に設定されている場合、DATE_SHORTDATE が既定値になります。

lpDateSYSTEMTIME*inoptional書式設定する日付情報を含む SYSTEMTIME 構造体へのポインターです。関数に現在のローカルシステム日付を使用させる場合、アプリケーションはこのパラメーターを NULL に設定できます。
lpFormatLPCWSTRinoptional

日付の形成に使用される書式指定文字列へのポインターです。書式指定文字列に指定できる値は、Day, Month, Year, and Era Format Pictures で定義されています。

たとえば、日付文字列 "Wed, Aug 31 94" を取得するには、アプリケーションは指定文字列 "ddd',' MMM dd yy" を使用します。

関数は、書式指定文字列で指定されていない情報(たとえば、ロケールの曜日名や月名)についてのみ、指定されたロケールを使用します。アプリケーションは、指定されたロケールの日付形式に従って文字列を書式設定するために、このパラメーターを NULL に設定できます。

lpDateStrLPWSTRoutoptionalこの関数が書式設定された日付文字列を取得するバッファーへのポインターです。
cchDateINTinlpDateStr バッファーのサイズ(文字数)です。アプリケーションは、書式設定された日付文字列を格納するために必要なバッファーサイズを返すために、このパラメーターを 0 に設定できます。この場合、lpDateStr で示されるバッファーは使用されません。
lpCalendarLPCWSTRinoptional予約済み。NULL に設定する必要があります。

戻り値の型: INT

公式ドキュメント

指定された名前のロケールに対して、日付を日付文字列として書式設定します。

戻り値

成功した場合、lpDateStr バッファーに書き込まれた文字数を返します。cchDate パラメーターが 0 に設定されている場合、関数は終端の null 文字を含む、書式設定された日付文字列を格納するために必要な文字数を返します。

この関数は、成功しなかった場合に 0 を返します。拡張エラー情報を取得するために、アプリケーションは GetLastError を呼び出すことができます。これは次のいずれかのエラーコードを返す可能性があります。

解説(Remarks)

注意 この API は、2019 年 5 月の日本の元号変更をサポートするために更新されています。アプリケーションが日本のカレンダーをサポートする場合は、新しい元号を適切に処理することを検証する必要があります。詳細については、Prepare your application for the Japanese era change を参照してください。
この関数がサポートする最も古い日付は、1601 年 1 月 1 日です。

曜日名、省略形の曜日名、月名、および省略形の月名は、すべてロケール識別子に基づいてローカライズされます。

lpDate で示される構造体の日付値は有効である必要があります。関数は、年、月、日、および曜日の各日付値をチェックします。曜日が正しくない場合、関数は正しい値を使用し、エラーを返しません。その他の日付値のいずれかが正しい範囲外である場合、関数は失敗し、最後のエラーを ERROR_INVALID_PARAMETER に設定します。

関数は、lpDate で示される SYSTEMTIME 構造体の時刻メンバーを無視します。これには、wHourwMinutewSecond、および wMilliseconds が含まれます。

lpFormat パラメーターに不正な書式文字列が含まれている場合、関数はエラーを返さず、可能な限り最善の日付文字列を形成します。たとえば、有効な年の指定は L"yyyy" と L"yy" のみです。ここで "L" は Unicode(16 ビット文字)文字列を示します。L"y" が渡された場合、関数は L"yy" と見なします。L"yyy" が渡された場合、関数は L"yyyy" と見なします。4 つを超える日(L"dddd")または 4 つを超える月(L"MMMM")の指定が渡された場合、関数は既定で L"dddd" または L"MMMM" になります。

アプリケーションは、日付文字列内で正確な形式のまま残すべきテキストを、日付書式指定文字列内の単一引用符で囲む必要があります。単一引用符は、単一引用符自体を日付文字列に表示できるようにするためのエスケープ文字としても使用できます。ただし、エスケープシーケンスは 2 つの単一引用符で囲む必要があります。たとえば、日付を "May '93" として表示するには、書式文字列は L"MMMM ''''yy" となります。最初と最後の単一引用符は囲み引用符です。2 番目と 3 番目の単一引用符は、世紀の前に単一引用符を表示できるようにするためのエスケープシーケンスです。

日付指定に日の数値形式(d または dd)と完全な月名(MMMM)の両方が含まれている場合、日付文字列には月名の属格形が取得されます。

実際の書式設定を行わずに既定の短い日付形式と長い日付形式を取得するには、アプリケーションは LOCALE_SSHORTDATE または LOCALE_SLONGDATE 定数を指定して GetLocaleInfoEx を使用する必要があります。代替カレンダーの日付形式を取得するには、アプリケーションは LOCALE_IOPTIONALCALENDAR 定数を指定して GetLocaleInfoEx を使用します。特定のカレンダーの日付形式を取得するには、アプリケーションは適切な Calendar Identifier を渡して GetCalendarInfoEx を使用します。特定のカレンダーの日付形式を取得するために、EnumCalendarInfoEx または EnumDateFormatsEx を呼び出すことができます。

この関数は、カスタムロケールからデータを取得できます。データは、コンピューター間やアプリケーションの実行間で同じであることは保証されません。アプリケーションがデータを永続化または送信する必要がある場合は、Using Persistent Locale Data を参照してください。

DATE_LONGDATE 形式には、2 種類の日付パターンが含まれます。曜日を含むパターンと曜日を含まないパターンです。たとえば、"Tuesday, October 18, 2016" または "October 18, 2016" です。アプリケーションが、日付がこれらのいずれか一方の種類のパターンを使用し、もう一方の種類を使用しないことを保証する必要がある場合、アプリケーションは次のアクションを実行する必要があります。

  1. EnumDateFormatsExEx 関数を呼び出して、DATE_LONGDATE 形式のすべての日付形式を取得します。
  2. EnumDateFormatsExEx 用に指定したコールバック関数に渡される日付形式のうち、要求したカレンダー識別子と一致し、かつアプリケーションの要件に合致する日付書式文字列を持つ最初の日付形式を探します。たとえば、日付に曜日の完全名を含める必要がある場合は "dddd" を含む最初の日付形式を探し、日付に曜日の省略名も完全名も含めない必要がある場合は "ddd" も "dddd" も含まない最初の日付形式を探します。
  3. lpFormat パラメーターを、コールバック関数で適切な形式として特定した日付書式文字列に設定して、GetDateFormatEx 関数を呼び出します。

長い日付形式における曜日の有無がアプリケーションにとって問題でない場合、アプリケーションは EnumDateFormatsExEx を呼び出してすべての長い日付形式を最初に列挙することなく、GetDateFormatEx を直接呼び出すことができます。

Windows 8 以降: アプリケーションが Windows.Globalization 名前空間からの言語タグをこの関数に渡す場合は、まず ResolveLocaleName を呼び出してタグを変換する必要があります。

Windows 8 以降: GetDateFormatEx は Datetimeapi.h で宣言されています。Windows 8 より前は、Winnls.h で宣言されていました。

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

各言語での呼び出し定義

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

INT GetDateFormatEx(
    LPCWSTR lpLocaleName,   // optional
    ENUM_DATE_FORMATS_FLAGS dwFlags,
    const SYSTEMTIME* lpDate,   // optional
    LPCWSTR lpFormat,   // optional
    LPWSTR lpDateStr,   // optional
    INT cchDate,
    LPCWSTR lpCalendar   // optional
);
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern int GetDateFormatEx(
    [MarshalAs(UnmanagedType.LPWStr)] string lpLocaleName,   // LPCWSTR optional
    uint dwFlags,   // ENUM_DATE_FORMATS_FLAGS
    IntPtr lpDate,   // SYSTEMTIME* optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpFormat,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpDateStr,   // LPWSTR optional, out
    int cchDate,   // INT
    [MarshalAs(UnmanagedType.LPWStr)] string lpCalendar   // LPCWSTR optional
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetDateFormatEx(
    <MarshalAs(UnmanagedType.LPWStr)> lpLocaleName As String,   ' LPCWSTR optional
    dwFlags As UInteger,   ' ENUM_DATE_FORMATS_FLAGS
    lpDate As IntPtr,   ' SYSTEMTIME* optional
    <MarshalAs(UnmanagedType.LPWStr)> lpFormat As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> lpDateStr As System.Text.StringBuilder,   ' LPWSTR optional, out
    cchDate As Integer,   ' INT
    <MarshalAs(UnmanagedType.LPWStr)> lpCalendar As String   ' LPCWSTR optional
) As Integer
End Function
' lpLocaleName : LPCWSTR optional
' dwFlags : ENUM_DATE_FORMATS_FLAGS
' lpDate : SYSTEMTIME* optional
' lpFormat : LPCWSTR optional
' lpDateStr : LPWSTR optional, out
' cchDate : INT
' lpCalendar : LPCWSTR optional
Declare PtrSafe Function GetDateFormatEx Lib "kernel32" ( _
    ByVal lpLocaleName As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal lpDate As LongPtr, _
    ByVal lpFormat As LongPtr, _
    ByVal lpDateStr As LongPtr, _
    ByVal cchDate As Long, _
    ByVal lpCalendar As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetDateFormatEx = ctypes.windll.kernel32.GetDateFormatEx
GetDateFormatEx.restype = ctypes.c_int
GetDateFormatEx.argtypes = [
    wintypes.LPCWSTR,  # lpLocaleName : LPCWSTR optional
    wintypes.DWORD,  # dwFlags : ENUM_DATE_FORMATS_FLAGS
    ctypes.c_void_p,  # lpDate : SYSTEMTIME* optional
    wintypes.LPCWSTR,  # lpFormat : LPCWSTR optional
    wintypes.LPWSTR,  # lpDateStr : LPWSTR optional, out
    ctypes.c_int,  # cchDate : INT
    wintypes.LPCWSTR,  # lpCalendar : LPCWSTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetDateFormatEx = Fiddle::Function.new(
  lib['GetDateFormatEx'],
  [
    Fiddle::TYPE_VOIDP,  # lpLocaleName : LPCWSTR optional
    -Fiddle::TYPE_INT,  # dwFlags : ENUM_DATE_FORMATS_FLAGS
    Fiddle::TYPE_VOIDP,  # lpDate : SYSTEMTIME* optional
    Fiddle::TYPE_VOIDP,  # lpFormat : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpDateStr : LPWSTR optional, out
    Fiddle::TYPE_INT,  # cchDate : INT
    Fiddle::TYPE_VOIDP,  # lpCalendar : LPCWSTR optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn GetDateFormatEx(
        lpLocaleName: *const u16,  // LPCWSTR optional
        dwFlags: u32,  // ENUM_DATE_FORMATS_FLAGS
        lpDate: *const SYSTEMTIME,  // SYSTEMTIME* optional
        lpFormat: *const u16,  // LPCWSTR optional
        lpDateStr: *mut u16,  // LPWSTR optional, out
        cchDate: i32,  // INT
        lpCalendar: *const u16  // LPCWSTR optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern int GetDateFormatEx([MarshalAs(UnmanagedType.LPWStr)] string lpLocaleName, uint dwFlags, IntPtr lpDate, [MarshalAs(UnmanagedType.LPWStr)] string lpFormat, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpDateStr, int cchDate, [MarshalAs(UnmanagedType.LPWStr)] string lpCalendar);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetDateFormatEx' -Namespace Win32 -PassThru
# $api::GetDateFormatEx(lpLocaleName, dwFlags, lpDate, lpFormat, lpDateStr, cchDate, lpCalendar)
#uselib "KERNEL32.dll"
#func global GetDateFormatEx "GetDateFormatEx" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; GetDateFormatEx lpLocaleName, dwFlags, varptr(lpDate), lpFormat, varptr(lpDateStr), cchDate, lpCalendar   ; 戻り値は stat
; lpLocaleName : LPCWSTR optional -> "sptr"
; dwFlags : ENUM_DATE_FORMATS_FLAGS -> "sptr"
; lpDate : SYSTEMTIME* optional -> "sptr"
; lpFormat : LPCWSTR optional -> "sptr"
; lpDateStr : LPWSTR optional, out -> "sptr"
; cchDate : INT -> "sptr"
; lpCalendar : LPCWSTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global GetDateFormatEx "GetDateFormatEx" wstr, int, var, wstr, var, int, wstr
; res = GetDateFormatEx(lpLocaleName, dwFlags, lpDate, lpFormat, lpDateStr, cchDate, lpCalendar)
; lpLocaleName : LPCWSTR optional -> "wstr"
; dwFlags : ENUM_DATE_FORMATS_FLAGS -> "int"
; lpDate : SYSTEMTIME* optional -> "var"
; lpFormat : LPCWSTR optional -> "wstr"
; lpDateStr : LPWSTR optional, out -> "var"
; cchDate : INT -> "int"
; lpCalendar : LPCWSTR optional -> "wstr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT GetDateFormatEx(LPCWSTR lpLocaleName, ENUM_DATE_FORMATS_FLAGS dwFlags, SYSTEMTIME* lpDate, LPCWSTR lpFormat, LPWSTR lpDateStr, INT cchDate, LPCWSTR lpCalendar)
#uselib "KERNEL32.dll"
#cfunc global GetDateFormatEx "GetDateFormatEx" wstr, int, var, wstr, var, int, wstr
; res = GetDateFormatEx(lpLocaleName, dwFlags, lpDate, lpFormat, lpDateStr, cchDate, lpCalendar)
; lpLocaleName : LPCWSTR optional -> "wstr"
; dwFlags : ENUM_DATE_FORMATS_FLAGS -> "int"
; lpDate : SYSTEMTIME* optional -> "var"
; lpFormat : LPCWSTR optional -> "wstr"
; lpDateStr : LPWSTR optional, out -> "var"
; cchDate : INT -> "int"
; lpCalendar : LPCWSTR optional -> "wstr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetDateFormatEx = kernel32.NewProc("GetDateFormatEx")
)

// lpLocaleName (LPCWSTR optional), dwFlags (ENUM_DATE_FORMATS_FLAGS), lpDate (SYSTEMTIME* optional), lpFormat (LPCWSTR optional), lpDateStr (LPWSTR optional, out), cchDate (INT), lpCalendar (LPCWSTR optional)
r1, _, err := procGetDateFormatEx.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpLocaleName))),
	uintptr(dwFlags),
	uintptr(lpDate),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpFormat))),
	uintptr(lpDateStr),
	uintptr(cchDate),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpCalendar))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function GetDateFormatEx(
  lpLocaleName: PWideChar;   // LPCWSTR optional
  dwFlags: DWORD;   // ENUM_DATE_FORMATS_FLAGS
  lpDate: Pointer;   // SYSTEMTIME* optional
  lpFormat: PWideChar;   // LPCWSTR optional
  lpDateStr: PWideChar;   // LPWSTR optional, out
  cchDate: Integer;   // INT
  lpCalendar: PWideChar   // LPCWSTR optional
): Integer; stdcall;
  external 'KERNEL32.dll' name 'GetDateFormatEx';
result := DllCall("KERNEL32\GetDateFormatEx"
    , "WStr", lpLocaleName   ; LPCWSTR optional
    , "UInt", dwFlags   ; ENUM_DATE_FORMATS_FLAGS
    , "Ptr", lpDate   ; SYSTEMTIME* optional
    , "WStr", lpFormat   ; LPCWSTR optional
    , "Ptr", lpDateStr   ; LPWSTR optional, out
    , "Int", cchDate   ; INT
    , "WStr", lpCalendar   ; LPCWSTR optional
    , "Int")   ; return: INT
●GetDateFormatEx(lpLocaleName, dwFlags, lpDate, lpFormat, lpDateStr, cchDate, lpCalendar) = DLL("KERNEL32.dll", "int GetDateFormatEx(char*, dword, void*, char*, char*, int, char*)")
# 呼び出し: GetDateFormatEx(lpLocaleName, dwFlags, lpDate, lpFormat, lpDateStr, cchDate, lpCalendar)
# lpLocaleName : LPCWSTR optional -> "char*"
# dwFlags : ENUM_DATE_FORMATS_FLAGS -> "dword"
# lpDate : SYSTEMTIME* optional -> "void*"
# lpFormat : LPCWSTR optional -> "char*"
# lpDateStr : LPWSTR optional, out -> "char*"
# cchDate : INT -> "int"
# lpCalendar : LPCWSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn GetDateFormatEx(
    lpLocaleName: [*c]const u16, // LPCWSTR optional
    dwFlags: u32, // ENUM_DATE_FORMATS_FLAGS
    lpDate: [*c]SYSTEMTIME, // SYSTEMTIME* optional
    lpFormat: [*c]const u16, // LPCWSTR optional
    lpDateStr: [*c]u16, // LPWSTR optional, out
    cchDate: i32, // INT
    lpCalendar: [*c]const u16 // LPCWSTR optional
) callconv(std.os.windows.WINAPI) i32;
proc GetDateFormatEx(
    lpLocaleName: WideCString,  # LPCWSTR optional
    dwFlags: uint32,  # ENUM_DATE_FORMATS_FLAGS
    lpDate: ptr SYSTEMTIME,  # SYSTEMTIME* optional
    lpFormat: WideCString,  # LPCWSTR optional
    lpDateStr: ptr uint16,  # LPWSTR optional, out
    cchDate: int32,  # INT
    lpCalendar: WideCString  # LPCWSTR optional
): int32 {.importc: "GetDateFormatEx", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int GetDateFormatEx(
    const(wchar)* lpLocaleName,   // LPCWSTR optional
    uint dwFlags,   // ENUM_DATE_FORMATS_FLAGS
    SYSTEMTIME* lpDate,   // SYSTEMTIME* optional
    const(wchar)* lpFormat,   // LPCWSTR optional
    wchar* lpDateStr,   // LPWSTR optional, out
    int cchDate,   // INT
    const(wchar)* lpCalendar   // LPCWSTR optional
);
ccall((:GetDateFormatEx, "KERNEL32.dll"), stdcall, Int32,
      (Cwstring, UInt32, Ptr{SYSTEMTIME}, Cwstring, Ptr{UInt16}, Int32, Cwstring),
      lpLocaleName, dwFlags, lpDate, lpFormat, lpDateStr, cchDate, lpCalendar)
# lpLocaleName : LPCWSTR optional -> Cwstring
# dwFlags : ENUM_DATE_FORMATS_FLAGS -> UInt32
# lpDate : SYSTEMTIME* optional -> Ptr{SYSTEMTIME}
# lpFormat : LPCWSTR optional -> Cwstring
# lpDateStr : LPWSTR optional, out -> Ptr{UInt16}
# cchDate : INT -> Int32
# lpCalendar : LPCWSTR optional -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetDateFormatEx(
    const uint16_t* lpLocaleName,
    uint32_t dwFlags,
    void* lpDate,
    const uint16_t* lpFormat,
    uint16_t* lpDateStr,
    int32_t cchDate,
    const uint16_t* lpCalendar);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetDateFormatEx(lpLocaleName, dwFlags, lpDate, lpFormat, lpDateStr, cchDate, lpCalendar)
-- lpLocaleName : LPCWSTR optional
-- dwFlags : ENUM_DATE_FORMATS_FLAGS
-- lpDate : SYSTEMTIME* optional
-- lpFormat : LPCWSTR optional
-- lpDateStr : LPWSTR optional, out
-- cchDate : INT
-- lpCalendar : LPCWSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetDateFormatEx = lib.func('__stdcall', 'GetDateFormatEx', 'int32_t', ['str16', 'uint32_t', 'void *', 'str16', 'uint16_t *', 'int32_t', 'str16']);
// GetDateFormatEx(lpLocaleName, dwFlags, lpDate, lpFormat, lpDateStr, cchDate, lpCalendar)
// lpLocaleName : LPCWSTR optional -> 'str16'
// dwFlags : ENUM_DATE_FORMATS_FLAGS -> 'uint32_t'
// lpDate : SYSTEMTIME* optional -> 'void *'
// lpFormat : LPCWSTR optional -> 'str16'
// lpDateStr : LPWSTR optional, out -> 'uint16_t *'
// cchDate : INT -> 'int32_t'
// lpCalendar : LPCWSTR optional -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetDateFormatEx: { parameters: ["buffer", "u32", "pointer", "buffer", "buffer", "i32", "buffer"], result: "i32" },
});
// lib.symbols.GetDateFormatEx(lpLocaleName, dwFlags, lpDate, lpFormat, lpDateStr, cchDate, lpCalendar)
// lpLocaleName : LPCWSTR optional -> "buffer"
// dwFlags : ENUM_DATE_FORMATS_FLAGS -> "u32"
// lpDate : SYSTEMTIME* optional -> "pointer"
// lpFormat : LPCWSTR optional -> "buffer"
// lpDateStr : LPWSTR optional, out -> "buffer"
// cchDate : INT -> "i32"
// lpCalendar : LPCWSTR optional -> "buffer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetDateFormatEx(
    const uint16_t* lpLocaleName,
    uint32_t dwFlags,
    void* lpDate,
    const uint16_t* lpFormat,
    uint16_t* lpDateStr,
    int32_t cchDate,
    const uint16_t* lpCalendar);
C, "KERNEL32.dll");
// $ffi->GetDateFormatEx(lpLocaleName, dwFlags, lpDate, lpFormat, lpDateStr, cchDate, lpCalendar);
// lpLocaleName : LPCWSTR optional
// dwFlags : ENUM_DATE_FORMATS_FLAGS
// lpDate : SYSTEMTIME* optional
// lpFormat : LPCWSTR optional
// lpDateStr : LPWSTR optional, out
// cchDate : INT
// lpCalendar : LPCWSTR optional
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    int GetDateFormatEx(
        WString lpLocaleName,   // LPCWSTR optional
        int dwFlags,   // ENUM_DATE_FORMATS_FLAGS
        Pointer lpDate,   // SYSTEMTIME* optional
        WString lpFormat,   // LPCWSTR optional
        char[] lpDateStr,   // LPWSTR optional, out
        int cchDate,   // INT
        WString lpCalendar   // LPCWSTR optional
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun GetDateFormatEx = GetDateFormatEx(
    lpLocaleName : UInt16*,   # LPCWSTR optional
    dwFlags : UInt32,   # ENUM_DATE_FORMATS_FLAGS
    lpDate : SYSTEMTIME*,   # SYSTEMTIME* optional
    lpFormat : UInt16*,   # LPCWSTR optional
    lpDateStr : UInt16*,   # LPWSTR optional, out
    cchDate : Int32,   # INT
    lpCalendar : UInt16*   # LPCWSTR optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetDateFormatExNative = Int32 Function(Pointer<Utf16>, Uint32, Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, Int32, Pointer<Utf16>);
typedef GetDateFormatExDart = int Function(Pointer<Utf16>, int, Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, int, Pointer<Utf16>);
final GetDateFormatEx = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetDateFormatExNative, GetDateFormatExDart>('GetDateFormatEx');
// lpLocaleName : LPCWSTR optional -> Pointer<Utf16>
// dwFlags : ENUM_DATE_FORMATS_FLAGS -> Uint32
// lpDate : SYSTEMTIME* optional -> Pointer<Void>
// lpFormat : LPCWSTR optional -> Pointer<Utf16>
// lpDateStr : LPWSTR optional, out -> Pointer<Utf16>
// cchDate : INT -> Int32
// lpCalendar : LPCWSTR optional -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetDateFormatEx(
  lpLocaleName: PWideChar;   // LPCWSTR optional
  dwFlags: DWORD;   // ENUM_DATE_FORMATS_FLAGS
  lpDate: Pointer;   // SYSTEMTIME* optional
  lpFormat: PWideChar;   // LPCWSTR optional
  lpDateStr: PWideChar;   // LPWSTR optional, out
  cchDate: Integer;   // INT
  lpCalendar: PWideChar   // LPCWSTR optional
): Integer; stdcall;
  external 'KERNEL32.dll' name 'GetDateFormatEx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetDateFormatEx"
  c_GetDateFormatEx :: CWString -> Word32 -> Ptr () -> CWString -> CWString -> Int32 -> CWString -> IO Int32
-- lpLocaleName : LPCWSTR optional -> CWString
-- dwFlags : ENUM_DATE_FORMATS_FLAGS -> Word32
-- lpDate : SYSTEMTIME* optional -> Ptr ()
-- lpFormat : LPCWSTR optional -> CWString
-- lpDateStr : LPWSTR optional, out -> CWString
-- cchDate : INT -> Int32
-- lpCalendar : LPCWSTR optional -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getdateformatex =
  foreign "GetDateFormatEx"
    ((ptr uint16_t) @-> uint32_t @-> (ptr void) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> int32_t @-> (ptr uint16_t) @-> returning int32_t)
(* lpLocaleName : LPCWSTR optional -> (ptr uint16_t) *)
(* dwFlags : ENUM_DATE_FORMATS_FLAGS -> uint32_t *)
(* lpDate : SYSTEMTIME* optional -> (ptr void) *)
(* lpFormat : LPCWSTR optional -> (ptr uint16_t) *)
(* lpDateStr : LPWSTR optional, out -> (ptr uint16_t) *)
(* cchDate : INT -> int32_t *)
(* lpCalendar : LPCWSTR optional -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetDateFormatEx" get-date-format-ex :convention :stdcall) :int32
  (lp-locale-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (dw-flags :uint32)   ; ENUM_DATE_FORMATS_FLAGS
  (lp-date :pointer)   ; SYSTEMTIME* optional
  (lp-format (:string :encoding :utf-16le))   ; LPCWSTR optional
  (lp-date-str :pointer)   ; LPWSTR optional, out
  (cch-date :int32)   ; INT
  (lp-calendar (:string :encoding :utf-16le)))   ; LPCWSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetDateFormatEx = Win32::API::More->new('KERNEL32',
    'int GetDateFormatEx(LPCWSTR lpLocaleName, DWORD dwFlags, LPVOID lpDate, LPCWSTR lpFormat, LPWSTR lpDateStr, int cchDate, LPCWSTR lpCalendar)');
# my $ret = $GetDateFormatEx->Call($lpLocaleName, $dwFlags, $lpDate, $lpFormat, $lpDateStr, $cchDate, $lpCalendar);
# lpLocaleName : LPCWSTR optional -> LPCWSTR
# dwFlags : ENUM_DATE_FORMATS_FLAGS -> DWORD
# lpDate : SYSTEMTIME* optional -> LPVOID
# lpFormat : LPCWSTR optional -> LPCWSTR
# lpDateStr : LPWSTR optional, out -> LPWSTR
# cchDate : INT -> int
# lpCalendar : LPCWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目
使用する型