Win32 API 日本語リファレンス
ホームUI.Shell › SHFormatDateTimeA

SHFormatDateTimeA

関数
FILETIMEを地域設定に応じた日時文字列へ整形する。
DLLSHLWAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

INT SHFormatDateTimeA(
    const FILETIME* pft,
    DWORD* pdwFlags,   // optional
    LPSTR pszBuf,
    DWORD cchBuf
);

パラメーター

名前方向説明
pftFILETIME*in文字列に変換する時刻を保持する FILETIME 構造体へのポインターです。
pdwFlagsDWORD*inoutoptional

日付および時刻の書式を指定するビット単位のフラグを格納する DWORD 値へのポインターです。

関数を呼び出す際には、次のフラグのうち 0 個以上を組み合わせて指定できます(注記のある例外を除く)。このパラメーターを NULL に設定することもでき、その場合、関数は FDTF_DEFAULT フラグが設定されているものとみなします。

FDTF_SHORTTIME (0x00000001)

0x00000001。コントロール パネルの [地域と言語のオプション] で指定された形式で時刻を書式設定しますが、秒は含めません。このフラグは FDTF_LONGTIME と組み合わせることはできません。

短い形式の時刻が正常に書式設定されました。

FDTF_SHORTDATE (0x00000002)

0x00000002。コントロール パネルの [地域と言語のオプション] で指定された短い日付形式で日付を書式設定します。このフラグは FDTF_LONGDATE と組み合わせることはできません。

短い形式の日付が正常に書式設定されました。

FDTF_DEFAULT

FDTF_SHORTDATE | FDTF_SHORTTIME と同等です。

FDTF_LONGDATE (0x00000004)

0x00000004。コントロール パネルの [地域と言語のオプション] で指定された長い日付形式で日付を書式設定します。このフラグは FDTF_SHORTDATE と組み合わせることはできません。

長い形式の日付が正常に書式設定されました。

FDTF_LONGTIME (0x00000008)

0x00000008。コントロール パネルの [地域と言語のオプション] で指定された形式で時刻を書式設定し、秒も含めます。このフラグは FDTF_SHORTTIME と組み合わせることはできません。

長い形式の時刻が正常に書式設定されました。

FDTF_RELATIVE (0x00000010)

0x00000010。FDTF_LONGDATE フラグが設定されており、FILETIME 構造体内の日付が SHFormatDateTime を呼び出した日付と同じ場合、曜日(存在する場合)は "今日" に変更されます。構造体内の日付が前日の場合、曜日(存在する場合)は "昨日" に変更されます。

日付に相対表記が使用されました。

FDTF_LTRDATE (0x00000100)

0x00000100。左から右への読み取りレイアウト用のマークを追加します。このフラグは FDTF_RTLDATE と組み合わせることはできません。

FDTF_RTLDATE (0x00000200)

0x00000200。右から左への読み取りレイアウト用のマークを追加します。このフラグは FDTF_LTRDATE と組み合わせることはできません。

FDTF_NOAUTOREADINGORDER (0x00000400)

0x00000400。読み取り順序マークは挿入されません。通常、FDTF_LTRDATE または FDTF_RTLDATE フラグが指定されていない場合、SHFormatDateTime はユーザーの既定のロケールから読み取り順序を判定し、読み取り順序マークを挿入して、pdwFlags の出力値を適切に更新します。このフラグはその処理が行われないようにします。これは主に SHFormatDateTime の従来からの呼び出し元によって使用されます。このフラグは FDTF_RTLDATE または FDTF_LTRDATE と組み合わせることはできません。

Windows Server 2003 および Windows XP: この値は利用できません。

関数が戻るとき、このパラメーターが指す DWORD 値には、次のフラグのうち 0 個以上が格納される場合があります。

pszBufLPSTRout書式設定された日付と時刻を受け取るバッファーへのポインターです。バッファーは、終端の null 文字を含め、cchBuf パラメーターで指定された数の TCHAR 文字を格納できる十分な大きさが必要です。
cchBufDWORDinpszBuf が指すバッファーに格納できる TCHAR の数です。

戻り値の型: INT

公式ドキュメント

SHFormatDateTime は変更されるか、利用できなくなる可能性があります。(ANSI)

戻り値

型: int

バッファーに書き込まれた TCHAR の数を、終端の null 文字を含めて返します。失敗した場合、この値は 0 になります。

解説(Remarks)

メモ

shlwapi.h ヘッダーは、SHFormatDateTime を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が生じ、コンパイル エラーや実行時エラーの原因となることがあります。詳細については、「関数プロトタイプの規則」を参照してください。

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

各言語での呼び出し定義

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

INT SHFormatDateTimeA(
    const FILETIME* pft,
    DWORD* pdwFlags,   // optional
    LPSTR pszBuf,
    DWORD cchBuf
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int SHFormatDateTimeA(
    IntPtr pft,   // FILETIME*
    IntPtr pdwFlags,   // DWORD* optional, in/out
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszBuf,   // LPSTR out
    uint cchBuf   // DWORD
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHFormatDateTimeA(
    pft As IntPtr,   ' FILETIME*
    pdwFlags As IntPtr,   ' DWORD* optional, in/out
    <MarshalAs(UnmanagedType.LPStr)> pszBuf As System.Text.StringBuilder,   ' LPSTR out
    cchBuf As UInteger   ' DWORD
) As Integer
End Function
' pft : FILETIME*
' pdwFlags : DWORD* optional, in/out
' pszBuf : LPSTR out
' cchBuf : DWORD
Declare PtrSafe Function SHFormatDateTimeA Lib "shlwapi" ( _
    ByVal pft As LongPtr, _
    ByVal pdwFlags As LongPtr, _
    ByVal pszBuf As String, _
    ByVal cchBuf As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHFormatDateTimeA = ctypes.windll.shlwapi.SHFormatDateTimeA
SHFormatDateTimeA.restype = ctypes.c_int
SHFormatDateTimeA.argtypes = [
    ctypes.c_void_p,  # pft : FILETIME*
    ctypes.POINTER(wintypes.DWORD),  # pdwFlags : DWORD* optional, in/out
    wintypes.LPSTR,  # pszBuf : LPSTR out
    wintypes.DWORD,  # cchBuf : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
SHFormatDateTimeA = Fiddle::Function.new(
  lib['SHFormatDateTimeA'],
  [
    Fiddle::TYPE_VOIDP,  # pft : FILETIME*
    Fiddle::TYPE_VOIDP,  # pdwFlags : DWORD* optional, in/out
    Fiddle::TYPE_VOIDP,  # pszBuf : LPSTR out
    -Fiddle::TYPE_INT,  # cchBuf : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "shlwapi")]
extern "system" {
    fn SHFormatDateTimeA(
        pft: *const FILETIME,  // FILETIME*
        pdwFlags: *mut u32,  // DWORD* optional, in/out
        pszBuf: *mut u8,  // LPSTR out
        cchBuf: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern int SHFormatDateTimeA(IntPtr pft, IntPtr pdwFlags, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszBuf, uint cchBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHFormatDateTimeA' -Namespace Win32 -PassThru
# $api::SHFormatDateTimeA(pft, pdwFlags, pszBuf, cchBuf)
#uselib "SHLWAPI.dll"
#func global SHFormatDateTimeA "SHFormatDateTimeA" sptr, sptr, sptr, sptr
; SHFormatDateTimeA varptr(pft), varptr(pdwFlags), varptr(pszBuf), cchBuf   ; 戻り値は stat
; pft : FILETIME* -> "sptr"
; pdwFlags : DWORD* optional, in/out -> "sptr"
; pszBuf : LPSTR out -> "sptr"
; cchBuf : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHLWAPI.dll"
#cfunc global SHFormatDateTimeA "SHFormatDateTimeA" var, var, var, int
; res = SHFormatDateTimeA(pft, pdwFlags, pszBuf, cchBuf)
; pft : FILETIME* -> "var"
; pdwFlags : DWORD* optional, in/out -> "var"
; pszBuf : LPSTR out -> "var"
; cchBuf : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT SHFormatDateTimeA(FILETIME* pft, DWORD* pdwFlags, LPSTR pszBuf, DWORD cchBuf)
#uselib "SHLWAPI.dll"
#cfunc global SHFormatDateTimeA "SHFormatDateTimeA" var, var, var, int
; res = SHFormatDateTimeA(pft, pdwFlags, pszBuf, cchBuf)
; pft : FILETIME* -> "var"
; pdwFlags : DWORD* optional, in/out -> "var"
; pszBuf : LPSTR out -> "var"
; cchBuf : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procSHFormatDateTimeA = shlwapi.NewProc("SHFormatDateTimeA")
)

// pft (FILETIME*), pdwFlags (DWORD* optional, in/out), pszBuf (LPSTR out), cchBuf (DWORD)
r1, _, err := procSHFormatDateTimeA.Call(
	uintptr(pft),
	uintptr(pdwFlags),
	uintptr(pszBuf),
	uintptr(cchBuf),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function SHFormatDateTimeA(
  pft: Pointer;   // FILETIME*
  pdwFlags: Pointer;   // DWORD* optional, in/out
  pszBuf: PAnsiChar;   // LPSTR out
  cchBuf: DWORD   // DWORD
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'SHFormatDateTimeA';
result := DllCall("SHLWAPI\SHFormatDateTimeA"
    , "Ptr", pft   ; FILETIME*
    , "Ptr", pdwFlags   ; DWORD* optional, in/out
    , "Ptr", pszBuf   ; LPSTR out
    , "UInt", cchBuf   ; DWORD
    , "Int")   ; return: INT
●SHFormatDateTimeA(pft, pdwFlags, pszBuf, cchBuf) = DLL("SHLWAPI.dll", "int SHFormatDateTimeA(void*, void*, char*, dword)")
# 呼び出し: SHFormatDateTimeA(pft, pdwFlags, pszBuf, cchBuf)
# pft : FILETIME* -> "void*"
# pdwFlags : DWORD* optional, in/out -> "void*"
# pszBuf : LPSTR out -> "char*"
# cchBuf : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "shlwapi" fn SHFormatDateTimeA(
    pft: [*c]FILETIME, // FILETIME*
    pdwFlags: [*c]u32, // DWORD* optional, in/out
    pszBuf: [*c]u8, // LPSTR out
    cchBuf: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc SHFormatDateTimeA(
    pft: ptr FILETIME,  # FILETIME*
    pdwFlags: ptr uint32,  # DWORD* optional, in/out
    pszBuf: ptr char,  # LPSTR out
    cchBuf: uint32  # DWORD
): int32 {.importc: "SHFormatDateTimeA", stdcall, dynlib: "SHLWAPI.dll".}
pragma(lib, "shlwapi");
extern(Windows)
int SHFormatDateTimeA(
    FILETIME* pft,   // FILETIME*
    uint* pdwFlags,   // DWORD* optional, in/out
    char* pszBuf,   // LPSTR out
    uint cchBuf   // DWORD
);
ccall((:SHFormatDateTimeA, "SHLWAPI.dll"), stdcall, Int32,
      (Ptr{FILETIME}, Ptr{UInt32}, Ptr{UInt8}, UInt32),
      pft, pdwFlags, pszBuf, cchBuf)
# pft : FILETIME* -> Ptr{FILETIME}
# pdwFlags : DWORD* optional, in/out -> Ptr{UInt32}
# pszBuf : LPSTR out -> Ptr{UInt8}
# cchBuf : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SHFormatDateTimeA(
    void* pft,
    uint32_t* pdwFlags,
    char* pszBuf,
    uint32_t cchBuf);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHFormatDateTimeA(pft, pdwFlags, pszBuf, cchBuf)
-- pft : FILETIME*
-- pdwFlags : DWORD* optional, in/out
-- pszBuf : LPSTR out
-- cchBuf : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const SHFormatDateTimeA = lib.func('__stdcall', 'SHFormatDateTimeA', 'int32_t', ['void *', 'uint32_t *', 'char *', 'uint32_t']);
// SHFormatDateTimeA(pft, pdwFlags, pszBuf, cchBuf)
// pft : FILETIME* -> 'void *'
// pdwFlags : DWORD* optional, in/out -> 'uint32_t *'
// pszBuf : LPSTR out -> 'char *'
// cchBuf : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  SHFormatDateTimeA: { parameters: ["pointer", "pointer", "buffer", "u32"], result: "i32" },
});
// lib.symbols.SHFormatDateTimeA(pft, pdwFlags, pszBuf, cchBuf)
// pft : FILETIME* -> "pointer"
// pdwFlags : DWORD* optional, in/out -> "pointer"
// pszBuf : LPSTR out -> "buffer"
// cchBuf : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SHFormatDateTimeA(
    void* pft,
    uint32_t* pdwFlags,
    char* pszBuf,
    uint32_t cchBuf);
C, "SHLWAPI.dll");
// $ffi->SHFormatDateTimeA(pft, pdwFlags, pszBuf, cchBuf);
// pft : FILETIME*
// pdwFlags : DWORD* optional, in/out
// pszBuf : LPSTR out
// cchBuf : DWORD
// 構造体/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 Shlwapi extends StdCallLibrary {
    Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class, W32APIOptions.ASCII_OPTIONS);
    int SHFormatDateTimeA(
        Pointer pft,   // FILETIME*
        IntByReference pdwFlags,   // DWORD* optional, in/out
        byte[] pszBuf,   // LPSTR out
        int cchBuf   // DWORD
    );
}
@[Link("shlwapi")]
lib LibSHLWAPI
  fun SHFormatDateTimeA = SHFormatDateTimeA(
    pft : FILETIME*,   # FILETIME*
    pdwFlags : UInt32*,   # DWORD* optional, in/out
    pszBuf : UInt8*,   # LPSTR out
    cchBuf : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHFormatDateTimeANative = Int32 Function(Pointer<Void>, Pointer<Uint32>, Pointer<Utf8>, Uint32);
typedef SHFormatDateTimeADart = int Function(Pointer<Void>, Pointer<Uint32>, Pointer<Utf8>, int);
final SHFormatDateTimeA = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<SHFormatDateTimeANative, SHFormatDateTimeADart>('SHFormatDateTimeA');
// pft : FILETIME* -> Pointer<Void>
// pdwFlags : DWORD* optional, in/out -> Pointer<Uint32>
// pszBuf : LPSTR out -> Pointer<Utf8>
// cchBuf : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHFormatDateTimeA(
  pft: Pointer;   // FILETIME*
  pdwFlags: Pointer;   // DWORD* optional, in/out
  pszBuf: PAnsiChar;   // LPSTR out
  cchBuf: DWORD   // DWORD
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'SHFormatDateTimeA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHFormatDateTimeA"
  c_SHFormatDateTimeA :: Ptr () -> Ptr Word32 -> CString -> Word32 -> IO Int32
-- pft : FILETIME* -> Ptr ()
-- pdwFlags : DWORD* optional, in/out -> Ptr Word32
-- pszBuf : LPSTR out -> CString
-- cchBuf : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shformatdatetimea =
  foreign "SHFormatDateTimeA"
    ((ptr void) @-> (ptr uint32_t) @-> string @-> uint32_t @-> returning int32_t)
(* pft : FILETIME* -> (ptr void) *)
(* pdwFlags : DWORD* optional, in/out -> (ptr uint32_t) *)
(* pszBuf : LPSTR out -> string *)
(* cchBuf : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("SHFormatDateTimeA" shformat-date-time-a :convention :stdcall) :int32
  (pft :pointer)   ; FILETIME*
  (pdw-flags :pointer)   ; DWORD* optional, in/out
  (psz-buf :pointer)   ; LPSTR out
  (cch-buf :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHFormatDateTimeA = Win32::API::More->new('SHLWAPI',
    'int SHFormatDateTimeA(LPVOID pft, LPVOID pdwFlags, LPSTR pszBuf, DWORD cchBuf)');
# my $ret = $SHFormatDateTimeA->Call($pft, $pdwFlags, $pszBuf, $cchBuf);
# pft : FILETIME* -> LPVOID
# pdwFlags : DWORD* optional, in/out -> LPVOID
# pszBuf : LPSTR out -> LPSTR
# cchBuf : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目
使用する型