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

EnumTimeFormatsEx

関数
指定ロケールの時刻書式をコールバックで列挙する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

BOOL EnumTimeFormatsEx(
    TIMEFMT_ENUMPROCEX lpTimeFmtEnumProcEx,
    LPCWSTR lpLocaleName,   // optional
    DWORD dwFlags,
    LPARAM lParam
);

パラメーター

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

ロケール名へのポインター、または次の定義済みの値のいずれか。

dwFlagsDWORDin時刻形式。現在のユーザーの長い時刻形式を使用するには 0 を設定し、短い時刻形式を使用するには TIME_NOSECONDS(Windows 7 以降)を設定します。
lParamLPARAMinコールバック関数に渡される、アプリケーション提供のパラメーター。これはマルチスレッドアプリケーションで特に有用です。

戻り値の型: BOOL

公式ドキュメント

名前で指定されたロケールで使用可能な時刻形式を列挙します。注意 Windows Vista 以降でのみ動作するように設計されている場合、アプリケーションは EnumTimeFormats よりもこの関数を優先して呼び出してください。 注意 この関数は、カスタムロケールなどの理由により、リリース間で変化するデータを列挙する可能性があります。アプリケーションでデータを永続化または送信する必要がある場合は、「Using Persistent Locale Data」を参照してください。

戻り値

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

解説(Remarks)

この関数は、時刻形式文字列へのポインターを 1 つずつ、マルチスレッドアプリケーションで有用なアプリケーション定義の定数とともに、指定されたアプリケーション定義のコールバック関数に渡すことで、時刻形式を列挙します。列挙の最初の値は常にユーザー既定(オーバーライド)値です。この関数は、最後の時刻形式が見つかるか、コールバック関数が FALSE を返すまで列挙を続けます。

Windows 8 以降: アプリケーションが Windows.Globalization 名前空間の言語タグをこの関数に渡す場合、まず ResolveLocaleName を呼び出してタグを変換する必要があります。

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

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

BOOL EnumTimeFormatsEx(
    TIMEFMT_ENUMPROCEX lpTimeFmtEnumProcEx,
    LPCWSTR lpLocaleName,   // optional
    DWORD dwFlags,
    LPARAM lParam
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool EnumTimeFormatsEx(
    IntPtr lpTimeFmtEnumProcEx,   // TIMEFMT_ENUMPROCEX
    [MarshalAs(UnmanagedType.LPWStr)] string lpLocaleName,   // LPCWSTR optional
    uint dwFlags,   // DWORD
    IntPtr lParam   // LPARAM
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EnumTimeFormatsEx(
    lpTimeFmtEnumProcEx As IntPtr,   ' TIMEFMT_ENUMPROCEX
    <MarshalAs(UnmanagedType.LPWStr)> lpLocaleName As String,   ' LPCWSTR optional
    dwFlags As UInteger,   ' DWORD
    lParam As IntPtr   ' LPARAM
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpTimeFmtEnumProcEx : TIMEFMT_ENUMPROCEX
' lpLocaleName : LPCWSTR optional
' dwFlags : DWORD
' lParam : LPARAM
Declare PtrSafe Function EnumTimeFormatsEx Lib "kernel32" ( _
    ByVal lpTimeFmtEnumProcEx As LongPtr, _
    ByVal lpLocaleName As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal lParam As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

EnumTimeFormatsEx = ctypes.windll.kernel32.EnumTimeFormatsEx
EnumTimeFormatsEx.restype = wintypes.BOOL
EnumTimeFormatsEx.argtypes = [
    ctypes.c_void_p,  # lpTimeFmtEnumProcEx : TIMEFMT_ENUMPROCEX
    wintypes.LPCWSTR,  # lpLocaleName : LPCWSTR optional
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_ssize_t,  # lParam : LPARAM
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procEnumTimeFormatsEx = kernel32.NewProc("EnumTimeFormatsEx")
)

// lpTimeFmtEnumProcEx (TIMEFMT_ENUMPROCEX), lpLocaleName (LPCWSTR optional), dwFlags (DWORD), lParam (LPARAM)
r1, _, err := procEnumTimeFormatsEx.Call(
	uintptr(lpTimeFmtEnumProcEx),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpLocaleName))),
	uintptr(dwFlags),
	uintptr(lParam),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function EnumTimeFormatsEx(
  lpTimeFmtEnumProcEx: Pointer;   // TIMEFMT_ENUMPROCEX
  lpLocaleName: PWideChar;   // LPCWSTR optional
  dwFlags: DWORD;   // DWORD
  lParam: NativeInt   // LPARAM
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'EnumTimeFormatsEx';
result := DllCall("KERNEL32\EnumTimeFormatsEx"
    , "Ptr", lpTimeFmtEnumProcEx   ; TIMEFMT_ENUMPROCEX
    , "WStr", lpLocaleName   ; LPCWSTR optional
    , "UInt", dwFlags   ; DWORD
    , "Ptr", lParam   ; LPARAM
    , "Int")   ; return: BOOL
●EnumTimeFormatsEx(lpTimeFmtEnumProcEx, lpLocaleName, dwFlags, lParam) = DLL("KERNEL32.dll", "bool EnumTimeFormatsEx(void*, char*, dword, int)")
# 呼び出し: EnumTimeFormatsEx(lpTimeFmtEnumProcEx, lpLocaleName, dwFlags, lParam)
# lpTimeFmtEnumProcEx : TIMEFMT_ENUMPROCEX -> "void*"
# lpLocaleName : LPCWSTR optional -> "char*"
# dwFlags : DWORD -> "dword"
# lParam : LPARAM -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef EnumTimeFormatsExNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Uint32, IntPtr);
typedef EnumTimeFormatsExDart = int Function(Pointer<Void>, Pointer<Utf16>, int, int);
final EnumTimeFormatsEx = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<EnumTimeFormatsExNative, EnumTimeFormatsExDart>('EnumTimeFormatsEx');
// lpTimeFmtEnumProcEx : TIMEFMT_ENUMPROCEX -> Pointer<Void>
// lpLocaleName : LPCWSTR optional -> Pointer<Utf16>
// dwFlags : DWORD -> Uint32
// lParam : LPARAM -> IntPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EnumTimeFormatsEx(
  lpTimeFmtEnumProcEx: Pointer;   // TIMEFMT_ENUMPROCEX
  lpLocaleName: PWideChar;   // LPCWSTR optional
  dwFlags: DWORD;   // DWORD
  lParam: NativeInt   // LPARAM
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'EnumTimeFormatsEx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "EnumTimeFormatsEx"
  c_EnumTimeFormatsEx :: Ptr () -> CWString -> Word32 -> CIntPtr -> IO CInt
-- lpTimeFmtEnumProcEx : TIMEFMT_ENUMPROCEX -> Ptr ()
-- lpLocaleName : LPCWSTR optional -> CWString
-- dwFlags : DWORD -> Word32
-- lParam : LPARAM -> CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let enumtimeformatsex =
  foreign "EnumTimeFormatsEx"
    ((ptr void) @-> (ptr uint16_t) @-> uint32_t @-> intptr_t @-> returning int32_t)
(* lpTimeFmtEnumProcEx : TIMEFMT_ENUMPROCEX -> (ptr void) *)
(* lpLocaleName : LPCWSTR optional -> (ptr uint16_t) *)
(* dwFlags : DWORD -> uint32_t *)
(* lParam : LPARAM -> intptr_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

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

関連項目

類似 API
使用する型