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

GetTimeFormatA

関数
指定ロケールに従い時刻を文字列へ整形する。ANSI版。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

INT GetTimeFormatA(
    DWORD Locale,
    DWORD dwFlags,
    const SYSTEMTIME* lpTime,   // optional
    LPCSTR lpFormat,   // optional
    LPSTR lpTimeStr,   // optional
    INT cchTime
);

パラメーター

名前方向
LocaleDWORDin
dwFlagsDWORDin
lpTimeSYSTEMTIME*inoptional
lpFormatLPCSTRinoptional
lpTimeStrLPSTRoutoptional
cchTimeINTin

戻り値の型: INT

各言語での呼び出し定義

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

INT GetTimeFormatA(
    DWORD Locale,
    DWORD dwFlags,
    const SYSTEMTIME* lpTime,   // optional
    LPCSTR lpFormat,   // optional
    LPSTR lpTimeStr,   // optional
    INT cchTime
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern int GetTimeFormatA(
    uint Locale,   // DWORD
    uint dwFlags,   // DWORD
    IntPtr lpTime,   // SYSTEMTIME* optional
    [MarshalAs(UnmanagedType.LPStr)] string lpFormat,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpTimeStr,   // LPSTR optional, out
    int cchTime   // INT
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetTimeFormatA(
    Locale As UInteger,   ' DWORD
    dwFlags As UInteger,   ' DWORD
    lpTime As IntPtr,   ' SYSTEMTIME* optional
    <MarshalAs(UnmanagedType.LPStr)> lpFormat As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> lpTimeStr As System.Text.StringBuilder,   ' LPSTR optional, out
    cchTime As Integer   ' INT
) As Integer
End Function
' Locale : DWORD
' dwFlags : DWORD
' lpTime : SYSTEMTIME* optional
' lpFormat : LPCSTR optional
' lpTimeStr : LPSTR optional, out
' cchTime : INT
Declare PtrSafe Function GetTimeFormatA Lib "kernel32" ( _
    ByVal Locale As Long, _
    ByVal dwFlags As Long, _
    ByVal lpTime As LongPtr, _
    ByVal lpFormat As String, _
    ByVal lpTimeStr As String, _
    ByVal cchTime As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetTimeFormatA = ctypes.windll.kernel32.GetTimeFormatA
GetTimeFormatA.restype = ctypes.c_int
GetTimeFormatA.argtypes = [
    wintypes.DWORD,  # Locale : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # lpTime : SYSTEMTIME* optional
    wintypes.LPCSTR,  # lpFormat : LPCSTR optional
    wintypes.LPSTR,  # lpTimeStr : LPSTR 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')
GetTimeFormatA = Fiddle::Function.new(
  lib['GetTimeFormatA'],
  [
    -Fiddle::TYPE_INT,  # Locale : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # lpTime : SYSTEMTIME* optional
    Fiddle::TYPE_VOIDP,  # lpFormat : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpTimeStr : LPSTR optional, out
    Fiddle::TYPE_INT,  # cchTime : INT
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn GetTimeFormatA(
        Locale: u32,  // DWORD
        dwFlags: u32,  // DWORD
        lpTime: *const SYSTEMTIME,  // SYSTEMTIME* optional
        lpFormat: *const u8,  // LPCSTR optional
        lpTimeStr: *mut u8,  // LPSTR optional, out
        cchTime: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern int GetTimeFormatA(uint Locale, uint dwFlags, IntPtr lpTime, [MarshalAs(UnmanagedType.LPStr)] string lpFormat, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpTimeStr, int cchTime);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetTimeFormatA' -Namespace Win32 -PassThru
# $api::GetTimeFormatA(Locale, dwFlags, lpTime, lpFormat, lpTimeStr, cchTime)
#uselib "KERNEL32.dll"
#func global GetTimeFormatA "GetTimeFormatA" sptr, sptr, sptr, sptr, sptr, sptr
; GetTimeFormatA Locale, dwFlags, varptr(lpTime), lpFormat, varptr(lpTimeStr), cchTime   ; 戻り値は stat
; Locale : DWORD -> "sptr"
; dwFlags : DWORD -> "sptr"
; lpTime : SYSTEMTIME* optional -> "sptr"
; lpFormat : LPCSTR optional -> "sptr"
; lpTimeStr : LPSTR optional, out -> "sptr"
; cchTime : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global GetTimeFormatA "GetTimeFormatA" int, int, var, str, var, int
; res = GetTimeFormatA(Locale, dwFlags, lpTime, lpFormat, lpTimeStr, cchTime)
; Locale : DWORD -> "int"
; dwFlags : DWORD -> "int"
; lpTime : SYSTEMTIME* optional -> "var"
; lpFormat : LPCSTR optional -> "str"
; lpTimeStr : LPSTR optional, out -> "var"
; cchTime : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT GetTimeFormatA(DWORD Locale, DWORD dwFlags, SYSTEMTIME* lpTime, LPCSTR lpFormat, LPSTR lpTimeStr, INT cchTime)
#uselib "KERNEL32.dll"
#cfunc global GetTimeFormatA "GetTimeFormatA" int, int, var, str, var, int
; res = GetTimeFormatA(Locale, dwFlags, lpTime, lpFormat, lpTimeStr, cchTime)
; Locale : DWORD -> "int"
; dwFlags : DWORD -> "int"
; lpTime : SYSTEMTIME* optional -> "var"
; lpFormat : LPCSTR optional -> "str"
; lpTimeStr : LPSTR optional, out -> "var"
; cchTime : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetTimeFormatA = kernel32.NewProc("GetTimeFormatA")
)

// Locale (DWORD), dwFlags (DWORD), lpTime (SYSTEMTIME* optional), lpFormat (LPCSTR optional), lpTimeStr (LPSTR optional, out), cchTime (INT)
r1, _, err := procGetTimeFormatA.Call(
	uintptr(Locale),
	uintptr(dwFlags),
	uintptr(lpTime),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpFormat))),
	uintptr(lpTimeStr),
	uintptr(cchTime),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function GetTimeFormatA(
  Locale: DWORD;   // DWORD
  dwFlags: DWORD;   // DWORD
  lpTime: Pointer;   // SYSTEMTIME* optional
  lpFormat: PAnsiChar;   // LPCSTR optional
  lpTimeStr: PAnsiChar;   // LPSTR optional, out
  cchTime: Integer   // INT
): Integer; stdcall;
  external 'KERNEL32.dll' name 'GetTimeFormatA';
result := DllCall("KERNEL32\GetTimeFormatA"
    , "UInt", Locale   ; DWORD
    , "UInt", dwFlags   ; DWORD
    , "Ptr", lpTime   ; SYSTEMTIME* optional
    , "AStr", lpFormat   ; LPCSTR optional
    , "Ptr", lpTimeStr   ; LPSTR optional, out
    , "Int", cchTime   ; INT
    , "Int")   ; return: INT
●GetTimeFormatA(Locale, dwFlags, lpTime, lpFormat, lpTimeStr, cchTime) = DLL("KERNEL32.dll", "int GetTimeFormatA(dword, dword, void*, char*, char*, int)")
# 呼び出し: GetTimeFormatA(Locale, dwFlags, lpTime, lpFormat, lpTimeStr, cchTime)
# Locale : DWORD -> "dword"
# dwFlags : DWORD -> "dword"
# lpTime : SYSTEMTIME* optional -> "void*"
# lpFormat : LPCSTR optional -> "char*"
# lpTimeStr : LPSTR optional, out -> "char*"
# cchTime : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。