GetTimeFormatEx

関数

ロケール名を指定して時刻を文字列へ整形する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

INT GetTimeFormatEx(
    LPCWSTR lpLocaleName,   // optional
    TIME_FORMAT_FLAGS dwFlags,
    const SYSTEMTIME* lpTime,   // optional
    LPCWSTR lpFormat,   // optional
    LPWSTR lpTimeStr,   // optional
    INT cchTime
);

パラメーター

名前

型

方向

説明

lpLocaleName

LPCWSTR

inoptional

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

dwFlags

TIME_FORMAT_FLAGS

時刻の書式設定オプションを指定するフラグ。アプリケーションは、以下の値と LOCALE_USE_CP_ACP または LOCALE_NOUSEROVERRIDE を組み合わせて指定できます。

注意 LOCALE_NOUSEROVERRIDE はユーザー設定を無効にするため、使用は強く推奨されません。

値	意味
TIME_NOMINUTESORSECONDS	分または秒を使用しません。
TIME_NOSECONDS	秒を使用しません。
TIME_NOTIMEMARKER	時刻マーカーを使用しません。
TIME_FORCE24HOURFORMAT	常に 24 時間制の時刻書式を使用します。

lpTime

SYSTEMTIME*

inoptional

書式設定する時刻情報を格納した SYSTEMTIME 構造体へのポインター。現在のローカルシステム時刻を使用させる場合、アプリケーションはこのパラメーターを NULL に設定できます。

lpFormat

LPCWSTR

inoptional

時刻文字列の書式設定に使用する書式指定文字列へのポインター。このパラメーターを NULL に設定すると、関数は指定したロケールの時刻書式に従って文字列を書式設定します。NULL に設定しない場合、関数は書式指定文字列で指定されていない情報(ロケール固有の時刻マーカーなど)についてのみロケールを使用します。書式指定文字列については「解説」セクションを参照してください。

lpTimeStr

LPWSTR

outoptional

この関数が書式設定済みの時刻文字列を取得するバッファーへのポインター。

cchTime

INT

lpTimeStr で示される時刻文字列バッファーのサイズ(文字数)。代わりに、アプリケーションはこのパラメーターを 0 に設定することもできます。その場合、関数は時刻文字列バッファーに必要なサイズを返し、lpTimeStr パラメーターは使用しません。

戻り値の型: INT

公式ドキュメント

名前で指定したロケールの時刻文字列として時刻を書式設定します。

戻り値

lpTimeStr で示されるバッファーに取得された文字数を返します。cchTime パラメーターが 0 に設定されている場合、関数は終端の null 文字を含む、書式設定済みの時刻文字列を保持するために必要なバッファーのサイズを返します。

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

ERROR_INSUFFICIENT_BUFFER。指定されたバッファーサイズが十分に大きくなかったか、誤って NULL に設定されていました。
ERROR_INVALID_FLAGS。フラグに指定された値が無効でした。
ERROR_INVALID_PARAMETER。いずれかのパラメーター値が無効でした。
ERROR_OUTOFMEMORY。この操作を完了するために十分な記憶域がありませんでした。

解説(Remarks)

時刻マーカーが存在し、TIME_NOTIMEMARKER フラグが設定されていない場合、関数は指定したロケール識別子に基づいて時刻マーカーをローカライズします。時刻マーカーの例としては、英語(米国)の "AM" や "PM" があります。

lpTime で示される構造体の時刻値は有効でなければなりません。関数は各時刻値が適切な値の範囲内にあるかどうかを確認します。いずれかの時刻値が正しい範囲外にある場合、関数は失敗し、最後のエラーを ERROR_INVALID_PARAMETER に設定します。

関数は SYSTEMTIME 構造体の日付メンバーを無視します。これには wYear、wMonth、wDayOfWeek、wDay が含まれます。

TIME_NOMINUTESORSECONDS または TIME_NOSECONDS が指定されている場合、関数は分および/または秒のメンバーに続く区切り文字を削除します。

TIME_NOTIMEMARKER が指定されている場合、関数は時刻マーカーの前後にある区切り文字を削除します。

TIME_FORCE24HOURFORMAT が指定されている場合、TIME_NOTIMEMARKER フラグも設定されていない限り、関数は既存の時刻マーカーを表示します。

関数は書式設定済みの時刻文字列にミリ秒を含めません。

関数は不正な書式文字列に対してエラーを返さず、可能な限り最良の時刻文字列を形成します。時、分、秒、または時刻マーカーの書式指定が 3 つ以上渡された場合、関数は既定で 2 つを使用します。たとえば、有効な時刻マーカーの書式指定は "t" と "tt" のみです。"ttt" が渡された場合、関数は "tt" とみなします。

実際の書式設定を行わずに時刻書式を取得するには、アプリケーションは GetLocaleInfoEx 関数を LOCALE_STIMEFORMAT を指定して使用する必要があります。

アプリケーションは書式指定文字列を構成するために以下の要素を使用できます。書式文字列内で要素を区切るためにスペースが使用された場合、それらのスペースは出力文字列の同じ位置に現れます。文字は示されているとおり大文字または小文字でなければなりません。たとえば "SS" ではなく "ss" です。書式文字列内で単一引用符で囲まれた文字は、出力文字列の同じ位置に変更されずに現れます。

書式指定	意味
h	1 桁の時には先頭にゼロを付けない時。12 時間制
hh	1 桁の時には先頭にゼロを付ける時。12 時間制
H	1 桁の時には先頭にゼロを付けない時。24 時間制
HH	1 桁の時には先頭にゼロを付ける時。24 時間制
m	1 桁の分には先頭にゼロを付けない分
mm	1 桁の分には先頭にゼロを付ける分
s	1 桁の秒には先頭にゼロを付けない秒
ss	1 桁の秒には先頭にゼロを付ける秒
t	A や P のような 1 文字の時刻マーカー文字列
tt	AM や PM のような複数文字の時刻マーカー文字列

たとえば、次の時刻文字列を取得するには

"11:29:40 PM"

アプリケーションは次の書式指定文字列を使用する必要があります

"hh':'mm':'ss tt"

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

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

Windows 8 以降: GetTimeFormatEx は 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 GetTimeFormatEx(
    LPCWSTR lpLocaleName,   // optional
    TIME_FORMAT_FLAGS dwFlags,
    const SYSTEMTIME* lpTime,   // optional
    LPCWSTR lpFormat,   // optional
    LPWSTR lpTimeStr,   // optional
    INT cchTime
);

[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern int GetTimeFormatEx(
    [MarshalAs(UnmanagedType.LPWStr)] string lpLocaleName,   // LPCWSTR optional
    uint dwFlags,   // TIME_FORMAT_FLAGS
    IntPtr lpTime,   // SYSTEMTIME* optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpFormat,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpTimeStr,   // LPWSTR optional, out
    int cchTime   // INT
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetTimeFormatEx(
    <MarshalAs(UnmanagedType.LPWStr)> lpLocaleName As String,   ' LPCWSTR optional
    dwFlags As UInteger,   ' TIME_FORMAT_FLAGS
    lpTime As IntPtr,   ' SYSTEMTIME* optional
    <MarshalAs(UnmanagedType.LPWStr)> lpFormat As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> lpTimeStr As System.Text.StringBuilder,   ' LPWSTR optional, out
    cchTime As Integer   ' INT
) As Integer
End Function

' lpLocaleName : LPCWSTR optional
' dwFlags : TIME_FORMAT_FLAGS
' lpTime : SYSTEMTIME* optional
' lpFormat : LPCWSTR optional
' lpTimeStr : LPWSTR optional, out
' cchTime : INT
Declare PtrSafe Function GetTimeFormatEx Lib "kernel32" ( _
    ByVal lpLocaleName As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal lpTime As LongPtr, _
    ByVal lpFormat As LongPtr, _
    ByVal lpTimeStr As LongPtr, _
    ByVal cchTime As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetTimeFormatEx = ctypes.windll.kernel32.GetTimeFormatEx
GetTimeFormatEx.restype = ctypes.c_int
GetTimeFormatEx.argtypes = [
    wintypes.LPCWSTR,  # lpLocaleName : LPCWSTR optional
    wintypes.DWORD,  # dwFlags : TIME_FORMAT_FLAGS
    ctypes.c_void_p,  # lpTime : SYSTEMTIME* optional
    wintypes.LPCWSTR,  # lpFormat : LPCWSTR optional
    wintypes.LPWSTR,  # lpTimeStr : LPWSTR optional, out
    ctypes.c_int,  # cchTime : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetTimeFormatEx = Fiddle::Function.new(
  lib['GetTimeFormatEx'],
  [
    Fiddle::TYPE_VOIDP,  # lpLocaleName : LPCWSTR optional
    -Fiddle::TYPE_INT,  # dwFlags : TIME_FORMAT_FLAGS
    Fiddle::TYPE_VOIDP,  # lpTime : SYSTEMTIME* optional
    Fiddle::TYPE_VOIDP,  # lpFormat : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpTimeStr : LPWSTR optional, out
    Fiddle::TYPE_INT,  # cchTime : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetTimeFormatEx(
        lpLocaleName: *const u16,  // LPCWSTR optional
        dwFlags: u32,  // TIME_FORMAT_FLAGS
        lpTime: *const SYSTEMTIME,  // SYSTEMTIME* optional
        lpFormat: *const u16,  // LPCWSTR optional
        lpTimeStr: *mut u16,  // LPWSTR optional, out
        cchTime: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern int GetTimeFormatEx([MarshalAs(UnmanagedType.LPWStr)] string lpLocaleName, uint dwFlags, IntPtr lpTime, [MarshalAs(UnmanagedType.LPWStr)] string lpFormat, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpTimeStr, int cchTime);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetTimeFormatEx' -Namespace Win32 -PassThru
# $api::GetTimeFormatEx(lpLocaleName, dwFlags, lpTime, lpFormat, lpTimeStr, cchTime)

#uselib "KERNEL32.dll"
#func global GetTimeFormatEx "GetTimeFormatEx" sptr, sptr, sptr, sptr, sptr, sptr
; GetTimeFormatEx lpLocaleName, dwFlags, varptr(lpTime), lpFormat, varptr(lpTimeStr), cchTime   ; 戻り値は stat
; lpLocaleName : LPCWSTR optional -> "sptr"
; dwFlags : TIME_FORMAT_FLAGS -> "sptr"
; lpTime : SYSTEMTIME* optional -> "sptr"
; lpFormat : LPCWSTR optional -> "sptr"
; lpTimeStr : LPWSTR optional, out -> "sptr"
; cchTime : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetTimeFormatEx "GetTimeFormatEx" wstr, int, var, wstr, var, int
; res = GetTimeFormatEx(lpLocaleName, dwFlags, lpTime, lpFormat, lpTimeStr, cchTime)
; lpLocaleName : LPCWSTR optional -> "wstr"
; dwFlags : TIME_FORMAT_FLAGS -> "int"
; lpTime : SYSTEMTIME* optional -> "var"
; lpFormat : LPCWSTR optional -> "wstr"
; lpTimeStr : LPWSTR optional, out -> "var"
; cchTime : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetTimeFormatEx "GetTimeFormatEx" wstr, int, sptr, wstr, sptr, int
; res = GetTimeFormatEx(lpLocaleName, dwFlags, varptr(lpTime), lpFormat, varptr(lpTimeStr), cchTime)
; lpLocaleName : LPCWSTR optional -> "wstr"
; dwFlags : TIME_FORMAT_FLAGS -> "int"
; lpTime : SYSTEMTIME* optional -> "sptr"
; lpFormat : LPCWSTR optional -> "wstr"
; lpTimeStr : LPWSTR optional, out -> "sptr"
; cchTime : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; INT GetTimeFormatEx(LPCWSTR lpLocaleName, TIME_FORMAT_FLAGS dwFlags, SYSTEMTIME* lpTime, LPCWSTR lpFormat, LPWSTR lpTimeStr, INT cchTime)
#uselib "KERNEL32.dll"
#cfunc global GetTimeFormatEx "GetTimeFormatEx" wstr, int, var, wstr, var, int
; res = GetTimeFormatEx(lpLocaleName, dwFlags, lpTime, lpFormat, lpTimeStr, cchTime)
; lpLocaleName : LPCWSTR optional -> "wstr"
; dwFlags : TIME_FORMAT_FLAGS -> "int"
; lpTime : SYSTEMTIME* optional -> "var"
; lpFormat : LPCWSTR optional -> "wstr"
; lpTimeStr : LPWSTR optional, out -> "var"
; cchTime : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; INT GetTimeFormatEx(LPCWSTR lpLocaleName, TIME_FORMAT_FLAGS dwFlags, SYSTEMTIME* lpTime, LPCWSTR lpFormat, LPWSTR lpTimeStr, INT cchTime)
#uselib "KERNEL32.dll"
#cfunc global GetTimeFormatEx "GetTimeFormatEx" wstr, int, intptr, wstr, intptr, int
; res = GetTimeFormatEx(lpLocaleName, dwFlags, varptr(lpTime), lpFormat, varptr(lpTimeStr), cchTime)
; lpLocaleName : LPCWSTR optional -> "wstr"
; dwFlags : TIME_FORMAT_FLAGS -> "int"
; lpTime : SYSTEMTIME* optional -> "intptr"
; lpFormat : LPCWSTR optional -> "wstr"
; lpTimeStr : LPWSTR optional, out -> "intptr"
; cchTime : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetTimeFormatEx = kernel32.NewProc("GetTimeFormatEx")
)

// lpLocaleName (LPCWSTR optional), dwFlags (TIME_FORMAT_FLAGS), lpTime (SYSTEMTIME* optional), lpFormat (LPCWSTR optional), lpTimeStr (LPWSTR optional, out), cchTime (INT)
r1, _, err := procGetTimeFormatEx.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpLocaleName))),
	uintptr(dwFlags),
	uintptr(lpTime),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpFormat))),
	uintptr(lpTimeStr),
	uintptr(cchTime),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT

function GetTimeFormatEx(
  lpLocaleName: PWideChar;   // LPCWSTR optional
  dwFlags: DWORD;   // TIME_FORMAT_FLAGS
  lpTime: Pointer;   // SYSTEMTIME* optional
  lpFormat: PWideChar;   // LPCWSTR optional
  lpTimeStr: PWideChar;   // LPWSTR optional, out
  cchTime: Integer   // INT
): Integer; stdcall;
  external 'KERNEL32.dll' name 'GetTimeFormatEx';

result := DllCall("KERNEL32\GetTimeFormatEx"
    , "WStr", lpLocaleName   ; LPCWSTR optional
    , "UInt", dwFlags   ; TIME_FORMAT_FLAGS
    , "Ptr", lpTime   ; SYSTEMTIME* optional
    , "WStr", lpFormat   ; LPCWSTR optional
    , "Ptr", lpTimeStr   ; LPWSTR optional, out
    , "Int", cchTime   ; INT
    , "Int")   ; return: INT

●GetTimeFormatEx(lpLocaleName, dwFlags, lpTime, lpFormat, lpTimeStr, cchTime) = DLL("KERNEL32.dll", "int GetTimeFormatEx(char*, dword, void*, char*, char*, int)")
# 呼び出し: GetTimeFormatEx(lpLocaleName, dwFlags, lpTime, lpFormat, lpTimeStr, cchTime)
# lpLocaleName : LPCWSTR optional -> "char*"
# dwFlags : TIME_FORMAT_FLAGS -> "dword"
# lpTime : SYSTEMTIME* optional -> "void*"
# lpFormat : LPCWSTR optional -> "char*"
# lpTimeStr : LPWSTR optional, out -> "char*"
# cchTime : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "kernel32" fn GetTimeFormatEx(
    lpLocaleName: [*c]const u16, // LPCWSTR optional
    dwFlags: u32, // TIME_FORMAT_FLAGS
    lpTime: [*c]SYSTEMTIME, // SYSTEMTIME* optional
    lpFormat: [*c]const u16, // LPCWSTR optional
    lpTimeStr: [*c]u16, // LPWSTR optional, out
    cchTime: i32 // INT
) callconv(std.os.windows.WINAPI) i32;

proc GetTimeFormatEx(
    lpLocaleName: WideCString,  # LPCWSTR optional
    dwFlags: uint32,  # TIME_FORMAT_FLAGS
    lpTime: ptr SYSTEMTIME,  # SYSTEMTIME* optional
    lpFormat: WideCString,  # LPCWSTR optional
    lpTimeStr: ptr uint16,  # LPWSTR optional, out
    cchTime: int32  # INT
): int32 {.importc: "GetTimeFormatEx", stdcall, dynlib: "KERNEL32.dll".}

pragma(lib, "kernel32");
extern(Windows)
int GetTimeFormatEx(
    const(wchar)* lpLocaleName,   // LPCWSTR optional
    uint dwFlags,   // TIME_FORMAT_FLAGS
    SYSTEMTIME* lpTime,   // SYSTEMTIME* optional
    const(wchar)* lpFormat,   // LPCWSTR optional
    wchar* lpTimeStr,   // LPWSTR optional, out
    int cchTime   // INT
);

ccall((:GetTimeFormatEx, "KERNEL32.dll"), stdcall, Int32,
      (Cwstring, UInt32, Ptr{SYSTEMTIME}, Cwstring, Ptr{UInt16}, Int32),
      lpLocaleName, dwFlags, lpTime, lpFormat, lpTimeStr, cchTime)
# lpLocaleName : LPCWSTR optional -> Cwstring
# dwFlags : TIME_FORMAT_FLAGS -> UInt32
# lpTime : SYSTEMTIME* optional -> Ptr{SYSTEMTIME}
# lpFormat : LPCWSTR optional -> Cwstring
# lpTimeStr : LPWSTR optional, out -> Ptr{UInt16}
# cchTime : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
int32_t GetTimeFormatEx(
    const uint16_t* lpLocaleName,
    uint32_t dwFlags,
    void* lpTime,
    const uint16_t* lpFormat,
    uint16_t* lpTimeStr,
    int32_t cchTime);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetTimeFormatEx(lpLocaleName, dwFlags, lpTime, lpFormat, lpTimeStr, cchTime)
-- lpLocaleName : LPCWSTR optional
-- dwFlags : TIME_FORMAT_FLAGS
-- lpTime : SYSTEMTIME* optional
-- lpFormat : LPCWSTR optional
-- lpTimeStr : LPWSTR optional, out
-- cchTime : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetTimeFormatEx = lib.func('__stdcall', 'GetTimeFormatEx', 'int32_t', ['str16', 'uint32_t', 'void *', 'str16', 'uint16_t *', 'int32_t']);
// GetTimeFormatEx(lpLocaleName, dwFlags, lpTime, lpFormat, lpTimeStr, cchTime)
// lpLocaleName : LPCWSTR optional -> 'str16'
// dwFlags : TIME_FORMAT_FLAGS -> 'uint32_t'
// lpTime : SYSTEMTIME* optional -> 'void *'
// lpFormat : LPCWSTR optional -> 'str16'
// lpTimeStr : LPWSTR optional, out -> 'uint16_t *'
// cchTime : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("KERNEL32.dll", {
  GetTimeFormatEx: { parameters: ["buffer", "u32", "pointer", "buffer", "buffer", "i32"], result: "i32" },
});
// lib.symbols.GetTimeFormatEx(lpLocaleName, dwFlags, lpTime, lpFormat, lpTimeStr, cchTime)
// lpLocaleName : LPCWSTR optional -> "buffer"
// dwFlags : TIME_FORMAT_FLAGS -> "u32"
// lpTime : SYSTEMTIME* optional -> "pointer"
// lpFormat : LPCWSTR optional -> "buffer"
// lpTimeStr : LPWSTR optional, out -> "buffer"
// cchTime : INT -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t GetTimeFormatEx(
    const uint16_t* lpLocaleName,
    uint32_t dwFlags,
    void* lpTime,
    const uint16_t* lpFormat,
    uint16_t* lpTimeStr,
    int32_t cchTime);
C, "KERNEL32.dll");
// $ffi->GetTimeFormatEx(lpLocaleName, dwFlags, lpTime, lpFormat, lpTimeStr, cchTime);
// lpLocaleName : LPCWSTR optional
// dwFlags : TIME_FORMAT_FLAGS
// lpTime : SYSTEMTIME* optional
// lpFormat : LPCWSTR optional
// lpTimeStr : LPWSTR optional, out
// cchTime : INT
// 構造体/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 GetTimeFormatEx(
        WString lpLocaleName,   // LPCWSTR optional
        int dwFlags,   // TIME_FORMAT_FLAGS
        Pointer lpTime,   // SYSTEMTIME* optional
        WString lpFormat,   // LPCWSTR optional
        char[] lpTimeStr,   // LPWSTR optional, out
        int cchTime   // INT
    );
}

@[Link("kernel32")]
lib LibKERNEL32
  fun GetTimeFormatEx = GetTimeFormatEx(
    lpLocaleName : UInt16*,   # LPCWSTR optional
    dwFlags : UInt32,   # TIME_FORMAT_FLAGS
    lpTime : SYSTEMTIME*,   # SYSTEMTIME* optional
    lpFormat : UInt16*,   # LPCWSTR optional
    lpTimeStr : UInt16*,   # LPWSTR optional, out
    cchTime : Int32   # INT
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetTimeFormatExNative = Int32 Function(Pointer<Utf16>, Uint32, Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, Int32);
typedef GetTimeFormatExDart = int Function(Pointer<Utf16>, int, Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, int);
final GetTimeFormatEx = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetTimeFormatExNative, GetTimeFormatExDart>('GetTimeFormatEx');
// lpLocaleName : LPCWSTR optional -> Pointer<Utf16>
// dwFlags : TIME_FORMAT_FLAGS -> Uint32
// lpTime : SYSTEMTIME* optional -> Pointer<Void>
// lpFormat : LPCWSTR optional -> Pointer<Utf16>
// lpTimeStr : LPWSTR optional, out -> Pointer<Utf16>
// cchTime : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function GetTimeFormatEx(
  lpLocaleName: PWideChar;   // LPCWSTR optional
  dwFlags: DWORD;   // TIME_FORMAT_FLAGS
  lpTime: Pointer;   // SYSTEMTIME* optional
  lpFormat: PWideChar;   // LPCWSTR optional
  lpTimeStr: PWideChar;   // LPWSTR optional, out
  cchTime: Integer   // INT
): Integer; stdcall;
  external 'KERNEL32.dll' name 'GetTimeFormatEx';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetTimeFormatEx"
  c_GetTimeFormatEx :: CWString -> Word32 -> Ptr () -> CWString -> CWString -> Int32 -> IO Int32
-- lpLocaleName : LPCWSTR optional -> CWString
-- dwFlags : TIME_FORMAT_FLAGS -> Word32
-- lpTime : SYSTEMTIME* optional -> Ptr ()
-- lpFormat : LPCWSTR optional -> CWString
-- lpTimeStr : LPWSTR optional, out -> CWString
-- cchTime : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let gettimeformatex =
  foreign "GetTimeFormatEx"
    ((ptr uint16_t) @-> uint32_t @-> (ptr void) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> int32_t @-> returning int32_t)
(* lpLocaleName : LPCWSTR optional -> (ptr uint16_t) *)
(* dwFlags : TIME_FORMAT_FLAGS -> uint32_t *)
(* lpTime : SYSTEMTIME* optional -> (ptr void) *)
(* lpFormat : LPCWSTR optional -> (ptr uint16_t) *)
(* lpTimeStr : LPWSTR optional, out -> (ptr uint16_t) *)
(* cchTime : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetTimeFormatEx" get-time-format-ex :convention :stdcall) :int32
  (lp-locale-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (dw-flags :uint32)   ; TIME_FORMAT_FLAGS
  (lp-time :pointer)   ; SYSTEMTIME* optional
  (lp-format (:string :encoding :utf-16le))   ; LPCWSTR optional
  (lp-time-str :pointer)   ; LPWSTR optional, out
  (cch-time :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $GetTimeFormatEx = Win32::API::More->new('KERNEL32',
    'int GetTimeFormatEx(LPCWSTR lpLocaleName, DWORD dwFlags, LPVOID lpTime, LPCWSTR lpFormat, LPWSTR lpTimeStr, int cchTime)');
# my $ret = $GetTimeFormatEx->Call($lpLocaleName, $dwFlags, $lpTime, $lpFormat, $lpTimeStr, $cchTime);
# lpLocaleName : LPCWSTR optional -> LPCWSTR
# dwFlags : TIME_FORMAT_FLAGS -> DWORD
# lpTime : SYSTEMTIME* optional -> LPVOID
# lpFormat : LPCWSTR optional -> LPCWSTR
# lpTimeStr : LPWSTR optional, out -> LPWSTR
# cchTime : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

GetTimeFormatEx

シグネチャ

パラメーター

公式ドキュメント

戻り値

解説(Remarks)

各言語での呼び出し定義

関連項目