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
);

パラメーター

名前	型	方向	説明
Locale	DWORD	in	ロケールを指定するロケール識別子です。MAKELCID マクロを使用してロケール識別子を作成するか、次の定義済みの値のいずれかを使用できます。 LOCALE_CUSTOM_DEFAULT LOCALE_CUSTOM_UI_DEFAULT LOCALE_CUSTOM_UNSPECIFIED LOCALE_INVARIANT LOCALE_SYSTEM_DEFAULT LOCALE_USER_DEFAULT
dwFlags	DWORD	in	時刻の書式設定オプションを指定するフラグです。詳細な定義については、GetTimeFormatEx の dwFlags パラメーターを参照してください。
lpTime	SYSTEMTIME*	inoptional	書式設定する時刻情報を含む SYSTEMTIME 構造体へのポインターです。関数に現在のローカルシステム時刻を使用させる場合、アプリケーションはこのパラメーターを NULL に設定できます。
lpFormat	LPCSTR	inoptional	時刻文字列の書式設定に使用する書式指定文字列(format picture)へのポインターです。アプリケーションがこのパラメーターを NULL に設定した場合、関数は指定されたロケールの時刻書式に従って文字列を書式設定します。アプリケーションがこのパラメーターを NULL に設定しない場合、関数は書式指定文字列で指定されていない情報(たとえばロケール固有の時刻マーカー)についてのみロケールを使用します。書式指定文字列については、「解説」セクションを参照してください。
lpTimeStr	LPSTR	outoptional	この関数が書式設定済みの時刻文字列を取得するバッファーへのポインターです。
cchTime	INT	in	lpTimeStr で示される時刻文字列バッファーのサイズ(TCHAR 値単位)です。あるいは、アプリケーションはこのパラメーターを 0 に設定することもできます。この場合、関数は時刻文字列バッファーに必要なサイズを返し、lpTimeStr パラメーターは使用しません。

戻り値の型: INT

公式ドキュメント

識別子で指定されたロケールに対して、時刻を時刻文字列として書式設定します。この関数は、指定された時刻またはローカルシステム時刻のいずれかを書式設定します。(ANSI)

戻り値

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

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

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

解説(Remarks)

解説については GetTimeFormatEx を参照してください。

この関数の ANSI 版を Unicode 専用のロケール識別子とともに使用した場合、オペレーティングシステムがシステムコードページを使用するため、関数は成功することがあります。ただし、システムコードページで未定義の文字は、文字列内で疑問符(?)として表示されます。

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

メモ

datetimeapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして GetTimeFormat を定義しています。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不整合が生じ、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、「Conventions for Function Prototypes」を参照してください。

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

各言語での呼び出し定義

// 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 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetTimeFormatA "GetTimeFormatA" int, int, sptr, str, sptr, int
; res = GetTimeFormatA(Locale, dwFlags, varptr(lpTime), lpFormat, varptr(lpTimeStr), cchTime)
; Locale : DWORD -> "int"
; dwFlags : DWORD -> "int"
; lpTime : SYSTEMTIME* optional -> "sptr"
; lpFormat : LPCSTR optional -> "str"
; lpTimeStr : LPSTR optional, out -> "sptr"
; cchTime : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。