GetDateFormatA

関数

指定ロケールに従い日付を文字列へ整形する。ANSI版。

DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

INT GetDateFormatA(
    DWORD Locale,
    DWORD dwFlags,
    const SYSTEMTIME* lpDate,   // optional
    LPCSTR lpFormat,   // optional
    LPSTR lpDateStr,   // optional
    INT cchDate
);

パラメーター

名前	型	方向	説明
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	日付の書式設定オプションを指定するフラグです。詳細な定義については、GetDateFormatEx の dwFlags パラメーターを参照してください。
lpDate	SYSTEMTIME*	inoptional	書式設定する日付情報を含む SYSTEMTIME 構造体へのポインターです。関数に現在のローカルシステム日付を使用させる場合、アプリケーションはこのパラメーターを NULL に設定します。
lpFormat	LPCSTR	inoptional	日付を構成するために使用される書式指定文字列へのポインターです。書式指定文字列に指定できる値は、Day, Month, Year, and Era Format Pictures で定義されています。この関数は、書式指定文字列で指定されていない情報(たとえばロケールの日名や月名)についてのみ、指定されたロケールを使用します。アプリケーションは、指定されたロケールの日付書式に従って文字列を書式設定するために、このパラメーターを NULL に設定できます。
lpDateStr	LPSTR	outoptional	この関数が書式設定された日付文字列を取得するバッファーへのポインターです。
cchDate	INT	in	lpDateStr バッファーのサイズ(文字数)です。アプリケーションは、書式設定された日付文字列を格納するために必要なバッファーサイズを返すために、このパラメーターを 0 に設定できます。この場合、lpDateStr が示すバッファーは使用されません。

戻り値の型: INT

公式ドキュメント

ロケール識別子で指定されたロケールに従って、日付を日付文字列として書式設定します。(ANSI)

戻り値

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

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

ERROR_INSUFFICIENT_BUFFER。指定されたバッファーサイズが十分に大きくないか、誤って NULL に設定されていました。
ERROR_INVALID_FLAGS。フラグに指定された値が無効でした。
ERROR_INVALID_PARAMETER。いずれかのパラメーター値が無効でした。

解説(Remarks)

Note この API は、2019 年 5 月の日本の元号変更をサポートするために更新されています。アプリケーションが和暦をサポートしている場合は、新しい元号を正しく処理することを検証してください。詳細については、Prepare your application for the Japanese era change を参照してください。

Remarks については GetDateFormatEx を参照してください。

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

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

メモ

datetimeapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI バージョンまたは Unicode バージョンを自動的に選択するエイリアスとして GetDateFormat を定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーまたは実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、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 GetDateFormatA(
    DWORD Locale,
    DWORD dwFlags,
    const SYSTEMTIME* lpDate,   // optional
    LPCSTR lpFormat,   // optional
    LPSTR lpDateStr,   // optional
    INT cchDate
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern int GetDateFormatA(
    uint Locale,   // DWORD
    uint dwFlags,   // DWORD
    IntPtr lpDate,   // SYSTEMTIME* optional
    [MarshalAs(UnmanagedType.LPStr)] string lpFormat,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpDateStr,   // LPSTR optional, out
    int cchDate   // INT
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetDateFormatA(
    Locale As UInteger,   ' DWORD
    dwFlags As UInteger,   ' DWORD
    lpDate As IntPtr,   ' SYSTEMTIME* optional
    <MarshalAs(UnmanagedType.LPStr)> lpFormat As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> lpDateStr As System.Text.StringBuilder,   ' LPSTR optional, out
    cchDate As Integer   ' INT
) As Integer
End Function

' Locale : DWORD
' dwFlags : DWORD
' lpDate : SYSTEMTIME* optional
' lpFormat : LPCSTR optional
' lpDateStr : LPSTR optional, out
' cchDate : INT
Declare PtrSafe Function GetDateFormatA Lib "kernel32" ( _
    ByVal Locale As Long, _
    ByVal dwFlags As Long, _
    ByVal lpDate As LongPtr, _
    ByVal lpFormat As String, _
    ByVal lpDateStr As String, _
    ByVal cchDate As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetDateFormatA = ctypes.windll.kernel32.GetDateFormatA
GetDateFormatA.restype = ctypes.c_int
GetDateFormatA.argtypes = [
    wintypes.DWORD,  # Locale : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # lpDate : SYSTEMTIME* optional
    wintypes.LPCSTR,  # lpFormat : LPCSTR optional
    wintypes.LPSTR,  # lpDateStr : LPSTR optional, out
    ctypes.c_int,  # cchDate : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetDateFormatA = Fiddle::Function.new(
  lib['GetDateFormatA'],
  [
    -Fiddle::TYPE_INT,  # Locale : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # lpDate : SYSTEMTIME* optional
    Fiddle::TYPE_VOIDP,  # lpFormat : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpDateStr : LPSTR optional, out
    Fiddle::TYPE_INT,  # cchDate : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetDateFormatA(
        Locale: u32,  // DWORD
        dwFlags: u32,  // DWORD
        lpDate: *const SYSTEMTIME,  // SYSTEMTIME* optional
        lpFormat: *const u8,  // LPCSTR optional
        lpDateStr: *mut u8,  // LPSTR optional, out
        cchDate: 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 GetDateFormatA(uint Locale, uint dwFlags, IntPtr lpDate, [MarshalAs(UnmanagedType.LPStr)] string lpFormat, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpDateStr, int cchDate);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetDateFormatA' -Namespace Win32 -PassThru
# $api::GetDateFormatA(Locale, dwFlags, lpDate, lpFormat, lpDateStr, cchDate)

#uselib "KERNEL32.dll"
#func global GetDateFormatA "GetDateFormatA" sptr, sptr, sptr, sptr, sptr, sptr
; GetDateFormatA Locale, dwFlags, varptr(lpDate), lpFormat, varptr(lpDateStr), cchDate   ; 戻り値は stat
; Locale : DWORD -> "sptr"
; dwFlags : DWORD -> "sptr"
; lpDate : SYSTEMTIME* optional -> "sptr"
; lpFormat : LPCSTR optional -> "sptr"
; lpDateStr : LPSTR optional, out -> "sptr"
; cchDate : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetDateFormatA "GetDateFormatA" int, int, var, str, var, int
; res = GetDateFormatA(Locale, dwFlags, lpDate, lpFormat, lpDateStr, cchDate)
; Locale : DWORD -> "int"
; dwFlags : DWORD -> "int"
; lpDate : SYSTEMTIME* optional -> "var"
; lpFormat : LPCSTR optional -> "str"
; lpDateStr : LPSTR optional, out -> "var"
; cchDate : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetDateFormatA "GetDateFormatA" int, int, sptr, str, sptr, int
; res = GetDateFormatA(Locale, dwFlags, varptr(lpDate), lpFormat, varptr(lpDateStr), cchDate)
; Locale : DWORD -> "int"
; dwFlags : DWORD -> "int"
; lpDate : SYSTEMTIME* optional -> "sptr"
; lpFormat : LPCSTR optional -> "str"
; lpDateStr : LPSTR optional, out -> "sptr"
; cchDate : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。