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

EnumTimeFormatsA

関数
ロケールで利用可能な時刻書式を列挙する。ANSI版。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL EnumTimeFormatsA(
    TIMEFMT_ENUMPROCA lpTimeFmtEnumProc,
    DWORD Locale,
    TIME_FORMAT_FLAGS dwFlags
);

パラメーター

名前方向説明
lpTimeFmtEnumProcTIMEFMT_ENUMPROCAinアプリケーション定義のコールバック関数へのポインターです。詳細については、EnumTimeFormatsProc を参照してください。
LocaleDWORDin

時刻形式情報を取得するロケールを指定する ロケール識別子です。MAKELCID マクロを使用してロケール識別子を作成するか、次の定義済みの値のいずれかを使用できます。

dwFlagsTIME_FORMAT_FLAGSin

時刻形式です。このパラメーターには、次の値の任意の組み合わせを指定できます。

フラグ 意味
0
現在のユーザーの長い時刻形式を使用します。
TIME_NOSECONDS
Windows 7 以降: 現在のユーザーの短い時刻形式を使用します。
注意 この値は、この関数の ANSI バージョンである EnumTimeFormatsA では動作しません。
LOCAL_USE_CP_ACP
この関数の ANSI バージョンである EnumTimeFormatsA(非推奨)とともに指定し、ロケールのコードページの代わりにシステム既定の Windows ANSI コードページ(ACP)を使用します。

戻り値の型: BOOL

公式ドキュメント

識別子で指定されたロケールで利用可能な時刻形式を列挙します。注意: 相互運用性の理由から、Microsoft は新しいロケールについてロケール識別子の代わりにロケール名の使用へ移行しているため、アプリケーションは EnumTimeFormats よりも EnumTimeFormatsEx 関数を優先して使用してください。Windows Vista 以降でのみ動作するアプリケーションは EnumTimeFormatsEx を使用してください。(ANSI)

戻り値

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

解説(Remarks)

この関数は、時刻形式を格納したバッファーへのポインターをアプリケーション定義のコールバック関数に渡すことで、時刻形式を列挙します。列挙における最初の値は、常にユーザー既定(オーバーライド)の値です。この関数は、最後の時刻形式が見つかるか、コールバック関数が FALSE を返すまで列挙を続けます。

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

この関数の ANSI バージョンを Unicode 専用のロケール識別子とともに使用すると、システムがシステムコードページを使用するため、呼び出しが成功することがあります。ただし、システムコードページで未定義の文字は、文字列内で疑問符("?")として表示されます。 将来導入される dwFlags の新しい値は、ANSI バージョンでは動作しないことに注意してください。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

BOOL EnumTimeFormatsA(
    TIMEFMT_ENUMPROCA lpTimeFmtEnumProc,
    DWORD Locale,
    TIME_FORMAT_FLAGS dwFlags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool EnumTimeFormatsA(
    IntPtr lpTimeFmtEnumProc,   // TIMEFMT_ENUMPROCA
    uint Locale,   // DWORD
    uint dwFlags   // TIME_FORMAT_FLAGS
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EnumTimeFormatsA(
    lpTimeFmtEnumProc As IntPtr,   ' TIMEFMT_ENUMPROCA
    Locale As UInteger,   ' DWORD
    dwFlags As UInteger   ' TIME_FORMAT_FLAGS
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpTimeFmtEnumProc : TIMEFMT_ENUMPROCA
' Locale : DWORD
' dwFlags : TIME_FORMAT_FLAGS
Declare PtrSafe Function EnumTimeFormatsA Lib "kernel32" ( _
    ByVal lpTimeFmtEnumProc As LongPtr, _
    ByVal Locale As Long, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

EnumTimeFormatsA = ctypes.windll.kernel32.EnumTimeFormatsA
EnumTimeFormatsA.restype = wintypes.BOOL
EnumTimeFormatsA.argtypes = [
    ctypes.c_void_p,  # lpTimeFmtEnumProc : TIMEFMT_ENUMPROCA
    wintypes.DWORD,  # Locale : DWORD
    wintypes.DWORD,  # dwFlags : TIME_FORMAT_FLAGS
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
EnumTimeFormatsA = Fiddle::Function.new(
  lib['EnumTimeFormatsA'],
  [
    Fiddle::TYPE_VOIDP,  # lpTimeFmtEnumProc : TIMEFMT_ENUMPROCA
    -Fiddle::TYPE_INT,  # Locale : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : TIME_FORMAT_FLAGS
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn EnumTimeFormatsA(
        lpTimeFmtEnumProc: *const core::ffi::c_void,  // TIMEFMT_ENUMPROCA
        Locale: u32,  // DWORD
        dwFlags: u32  // TIME_FORMAT_FLAGS
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool EnumTimeFormatsA(IntPtr lpTimeFmtEnumProc, uint Locale, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_EnumTimeFormatsA' -Namespace Win32 -PassThru
# $api::EnumTimeFormatsA(lpTimeFmtEnumProc, Locale, dwFlags)
#uselib "KERNEL32.dll"
#func global EnumTimeFormatsA "EnumTimeFormatsA" sptr, sptr, sptr
; EnumTimeFormatsA lpTimeFmtEnumProc, Locale, dwFlags   ; 戻り値は stat
; lpTimeFmtEnumProc : TIMEFMT_ENUMPROCA -> "sptr"
; Locale : DWORD -> "sptr"
; dwFlags : TIME_FORMAT_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global EnumTimeFormatsA "EnumTimeFormatsA" sptr, int, int
; res = EnumTimeFormatsA(lpTimeFmtEnumProc, Locale, dwFlags)
; lpTimeFmtEnumProc : TIMEFMT_ENUMPROCA -> "sptr"
; Locale : DWORD -> "int"
; dwFlags : TIME_FORMAT_FLAGS -> "int"
; BOOL EnumTimeFormatsA(TIMEFMT_ENUMPROCA lpTimeFmtEnumProc, DWORD Locale, TIME_FORMAT_FLAGS dwFlags)
#uselib "KERNEL32.dll"
#cfunc global EnumTimeFormatsA "EnumTimeFormatsA" intptr, int, int
; res = EnumTimeFormatsA(lpTimeFmtEnumProc, Locale, dwFlags)
; lpTimeFmtEnumProc : TIMEFMT_ENUMPROCA -> "intptr"
; Locale : DWORD -> "int"
; dwFlags : TIME_FORMAT_FLAGS -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procEnumTimeFormatsA = kernel32.NewProc("EnumTimeFormatsA")
)

// lpTimeFmtEnumProc (TIMEFMT_ENUMPROCA), Locale (DWORD), dwFlags (TIME_FORMAT_FLAGS)
r1, _, err := procEnumTimeFormatsA.Call(
	uintptr(lpTimeFmtEnumProc),
	uintptr(Locale),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function EnumTimeFormatsA(
  lpTimeFmtEnumProc: Pointer;   // TIMEFMT_ENUMPROCA
  Locale: DWORD;   // DWORD
  dwFlags: DWORD   // TIME_FORMAT_FLAGS
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'EnumTimeFormatsA';
result := DllCall("KERNEL32\EnumTimeFormatsA"
    , "Ptr", lpTimeFmtEnumProc   ; TIMEFMT_ENUMPROCA
    , "UInt", Locale   ; DWORD
    , "UInt", dwFlags   ; TIME_FORMAT_FLAGS
    , "Int")   ; return: BOOL
●EnumTimeFormatsA(lpTimeFmtEnumProc, Locale, dwFlags) = DLL("KERNEL32.dll", "bool EnumTimeFormatsA(void*, dword, dword)")
# 呼び出し: EnumTimeFormatsA(lpTimeFmtEnumProc, Locale, dwFlags)
# lpTimeFmtEnumProc : TIMEFMT_ENUMPROCA -> "void*"
# Locale : DWORD -> "dword"
# dwFlags : TIME_FORMAT_FLAGS -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn EnumTimeFormatsA(
    lpTimeFmtEnumProc: ?*anyopaque, // TIMEFMT_ENUMPROCA
    Locale: u32, // DWORD
    dwFlags: u32 // TIME_FORMAT_FLAGS
) callconv(std.os.windows.WINAPI) i32;
proc EnumTimeFormatsA(
    lpTimeFmtEnumProc: pointer,  # TIMEFMT_ENUMPROCA
    Locale: uint32,  # DWORD
    dwFlags: uint32  # TIME_FORMAT_FLAGS
): int32 {.importc: "EnumTimeFormatsA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int EnumTimeFormatsA(
    void* lpTimeFmtEnumProc,   // TIMEFMT_ENUMPROCA
    uint Locale,   // DWORD
    uint dwFlags   // TIME_FORMAT_FLAGS
);
ccall((:EnumTimeFormatsA, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, UInt32),
      lpTimeFmtEnumProc, Locale, dwFlags)
# lpTimeFmtEnumProc : TIMEFMT_ENUMPROCA -> Ptr{Cvoid}
# Locale : DWORD -> UInt32
# dwFlags : TIME_FORMAT_FLAGS -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t EnumTimeFormatsA(
    void* lpTimeFmtEnumProc,
    uint32_t Locale,
    uint32_t dwFlags);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.EnumTimeFormatsA(lpTimeFmtEnumProc, Locale, dwFlags)
-- lpTimeFmtEnumProc : TIMEFMT_ENUMPROCA
-- Locale : DWORD
-- dwFlags : TIME_FORMAT_FLAGS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const EnumTimeFormatsA = lib.func('__stdcall', 'EnumTimeFormatsA', 'int32_t', ['void *', 'uint32_t', 'uint32_t']);
// EnumTimeFormatsA(lpTimeFmtEnumProc, Locale, dwFlags)
// lpTimeFmtEnumProc : TIMEFMT_ENUMPROCA -> 'void *'
// Locale : DWORD -> 'uint32_t'
// dwFlags : TIME_FORMAT_FLAGS -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("KERNEL32.dll", {
  EnumTimeFormatsA: { parameters: ["pointer", "u32", "u32"], result: "i32" },
});
// lib.symbols.EnumTimeFormatsA(lpTimeFmtEnumProc, Locale, dwFlags)
// lpTimeFmtEnumProc : TIMEFMT_ENUMPROCA -> "pointer"
// Locale : DWORD -> "u32"
// dwFlags : TIME_FORMAT_FLAGS -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t EnumTimeFormatsA(
    void* lpTimeFmtEnumProc,
    uint32_t Locale,
    uint32_t dwFlags);
C, "KERNEL32.dll");
// $ffi->EnumTimeFormatsA(lpTimeFmtEnumProc, Locale, dwFlags);
// lpTimeFmtEnumProc : TIMEFMT_ENUMPROCA
// Locale : DWORD
// dwFlags : TIME_FORMAT_FLAGS
// 構造体/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, W32APIOptions.ASCII_OPTIONS);
    boolean EnumTimeFormatsA(
        Callback lpTimeFmtEnumProc,   // TIMEFMT_ENUMPROCA
        int Locale,   // DWORD
        int dwFlags   // TIME_FORMAT_FLAGS
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun EnumTimeFormatsA = EnumTimeFormatsA(
    lpTimeFmtEnumProc : Void*,   # TIMEFMT_ENUMPROCA
    Locale : UInt32,   # DWORD
    dwFlags : UInt32   # TIME_FORMAT_FLAGS
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef EnumTimeFormatsANative = Int32 Function(Pointer<Void>, Uint32, Uint32);
typedef EnumTimeFormatsADart = int Function(Pointer<Void>, int, int);
final EnumTimeFormatsA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<EnumTimeFormatsANative, EnumTimeFormatsADart>('EnumTimeFormatsA');
// lpTimeFmtEnumProc : TIMEFMT_ENUMPROCA -> Pointer<Void>
// Locale : DWORD -> Uint32
// dwFlags : TIME_FORMAT_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EnumTimeFormatsA(
  lpTimeFmtEnumProc: Pointer;   // TIMEFMT_ENUMPROCA
  Locale: DWORD;   // DWORD
  dwFlags: DWORD   // TIME_FORMAT_FLAGS
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'EnumTimeFormatsA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "EnumTimeFormatsA"
  c_EnumTimeFormatsA :: Ptr () -> Word32 -> Word32 -> IO CInt
-- lpTimeFmtEnumProc : TIMEFMT_ENUMPROCA -> Ptr ()
-- Locale : DWORD -> Word32
-- dwFlags : TIME_FORMAT_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let enumtimeformatsa =
  foreign "EnumTimeFormatsA"
    ((ptr void) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* lpTimeFmtEnumProc : TIMEFMT_ENUMPROCA -> (ptr void) *)
(* Locale : DWORD -> uint32_t *)
(* dwFlags : TIME_FORMAT_FLAGS -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("EnumTimeFormatsA" enum-time-formats-a :convention :stdcall) :int32
  (lp-time-fmt-enum-proc :pointer)   ; TIMEFMT_ENUMPROCA
  (locale :uint32)   ; DWORD
  (dw-flags :uint32))   ; TIME_FORMAT_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EnumTimeFormatsA = Win32::API::More->new('KERNEL32',
    'BOOL EnumTimeFormatsA(LPVOID lpTimeFmtEnumProc, DWORD Locale, DWORD dwFlags)');
# my $ret = $EnumTimeFormatsA->Call($lpTimeFmtEnumProc, $Locale, $dwFlags);
# lpTimeFmtEnumProc : TIMEFMT_ENUMPROCA -> LPVOID
# Locale : DWORD -> DWORD
# dwFlags : TIME_FORMAT_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

文字セット違い
類似 API
使用する型