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

EnumDateFormatsExW

関数
暦情報付きで日付書式を列挙する。Unicode版。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

BOOL EnumDateFormatsExW(
    DATEFMT_ENUMPROCEXW lpDateFmtEnumProcEx,
    DWORD Locale,
    DWORD dwFlags
);

パラメーター

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

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

Windows Vista 以降: 次のカスタムロケール識別子もサポートされます。
dwFlagsDWORDin日付書式を指定するフラグです。詳細な定義については、EnumDateFormatsExExdwFlags パラメーターを参照してください。

戻り値の型: BOOL

公式ドキュメント

指定したロケールで使用可能な、長い形式の日付、短い形式の日付、または年/月の書式を列挙します。注意 Windows Vista 以降でのみ動作するアプリケーションでは、この関数よりも EnumDateFormatsExEx を使用してください。(Unicode)

戻り値

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

解説(Remarks)

注意 この API は、2019 年 5 月の日本の元号変更に対応するために更新されています。アプリケーションが和暦をサポートしている場合は、新しい元号を正しく処理できることを検証してください。詳細については、日本の元号変更に向けてアプリケーションを準備するを参照してください。
この関数は、日付書式文字列へのポインターを 1 つずつ、指定したアプリケーション定義のコールバック関数に渡すことで、日付書式を列挙します。この処理は、EnumDateFormatsEx が最後の日付書式を見つけるか、またはコールバック関数が FALSE を返すまで続行されます。

この関数は、代替カレンダーがある場合はそれも含めて、指定したロケールのすべての日付書式を列挙します。ただし、カレンダー識別子は日付書式と一緒には列挙されないため、代替カレンダーを持つロケールの書式は扱いにくくなります。

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

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

代替カレンダーを持つロケールの日付書式を列挙するには、アプリケーションは(EnumDateFormats ではなく)EnumDateFormatsEx を使用してください。

メモ

winnls.h ヘッダーは、EnumDateFormatsEx を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI バージョンと Unicode バージョンを自動的に選択するエイリアスとして定義します。エンコード中立のエイリアスの使用を、エンコード中立でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不整合が発生する可能性があります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

BOOL EnumDateFormatsExW(
    DATEFMT_ENUMPROCEXW lpDateFmtEnumProcEx,
    DWORD Locale,
    DWORD dwFlags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool EnumDateFormatsExW(
    IntPtr lpDateFmtEnumProcEx,   // DATEFMT_ENUMPROCEXW
    uint Locale,   // DWORD
    uint dwFlags   // DWORD
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EnumDateFormatsExW(
    lpDateFmtEnumProcEx As IntPtr,   ' DATEFMT_ENUMPROCEXW
    Locale As UInteger,   ' DWORD
    dwFlags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpDateFmtEnumProcEx : DATEFMT_ENUMPROCEXW
' Locale : DWORD
' dwFlags : DWORD
Declare PtrSafe Function EnumDateFormatsExW Lib "kernel32" ( _
    ByVal lpDateFmtEnumProcEx As LongPtr, _
    ByVal Locale As Long, _
    ByVal dwFlags As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procEnumDateFormatsExW = kernel32.NewProc("EnumDateFormatsExW")
)

// lpDateFmtEnumProcEx (DATEFMT_ENUMPROCEXW), Locale (DWORD), dwFlags (DWORD)
r1, _, err := procEnumDateFormatsExW.Call(
	uintptr(lpDateFmtEnumProcEx),
	uintptr(Locale),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function EnumDateFormatsExW(
  lpDateFmtEnumProcEx: Pointer;   // DATEFMT_ENUMPROCEXW
  Locale: DWORD;   // DWORD
  dwFlags: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'EnumDateFormatsExW';
result := DllCall("KERNEL32\EnumDateFormatsExW"
    , "Ptr", lpDateFmtEnumProcEx   ; DATEFMT_ENUMPROCEXW
    , "UInt", Locale   ; DWORD
    , "UInt", dwFlags   ; DWORD
    , "Int")   ; return: BOOL
●EnumDateFormatsExW(lpDateFmtEnumProcEx, Locale, dwFlags) = DLL("KERNEL32.dll", "bool EnumDateFormatsExW(void*, dword, dword)")
# 呼び出し: EnumDateFormatsExW(lpDateFmtEnumProcEx, Locale, dwFlags)
# lpDateFmtEnumProcEx : DATEFMT_ENUMPROCEXW -> "void*"
# Locale : DWORD -> "dword"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn EnumDateFormatsExW(
    lpDateFmtEnumProcEx: ?*anyopaque, // DATEFMT_ENUMPROCEXW
    Locale: u32, // DWORD
    dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc EnumDateFormatsExW(
    lpDateFmtEnumProcEx: pointer,  # DATEFMT_ENUMPROCEXW
    Locale: uint32,  # DWORD
    dwFlags: uint32  # DWORD
): int32 {.importc: "EnumDateFormatsExW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
int EnumDateFormatsExW(
    void* lpDateFmtEnumProcEx,   // DATEFMT_ENUMPROCEXW
    uint Locale,   // DWORD
    uint dwFlags   // DWORD
);
ccall((:EnumDateFormatsExW, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, UInt32),
      lpDateFmtEnumProcEx, Locale, dwFlags)
# lpDateFmtEnumProcEx : DATEFMT_ENUMPROCEXW -> Ptr{Cvoid}
# Locale : DWORD -> UInt32
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t EnumDateFormatsExW(
    void* lpDateFmtEnumProcEx,
    uint32_t Locale,
    uint32_t dwFlags);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.EnumDateFormatsExW(lpDateFmtEnumProcEx, Locale, dwFlags)
-- lpDateFmtEnumProcEx : DATEFMT_ENUMPROCEXW
-- Locale : DWORD
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const EnumDateFormatsExW = lib.func('__stdcall', 'EnumDateFormatsExW', 'int32_t', ['void *', 'uint32_t', 'uint32_t']);
// EnumDateFormatsExW(lpDateFmtEnumProcEx, Locale, dwFlags)
// lpDateFmtEnumProcEx : DATEFMT_ENUMPROCEXW -> 'void *'
// Locale : DWORD -> 'uint32_t'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("KERNEL32.dll", {
  EnumDateFormatsExW: { parameters: ["pointer", "u32", "u32"], result: "i32" },
});
// lib.symbols.EnumDateFormatsExW(lpDateFmtEnumProcEx, Locale, dwFlags)
// lpDateFmtEnumProcEx : DATEFMT_ENUMPROCEXW -> "pointer"
// Locale : DWORD -> "u32"
// dwFlags : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t EnumDateFormatsExW(
    void* lpDateFmtEnumProcEx,
    uint32_t Locale,
    uint32_t dwFlags);
C, "KERNEL32.dll");
// $ffi->EnumDateFormatsExW(lpDateFmtEnumProcEx, Locale, dwFlags);
// lpDateFmtEnumProcEx : DATEFMT_ENUMPROCEXW
// Locale : DWORD
// dwFlags : 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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class, W32APIOptions.UNICODE_OPTIONS);
    boolean EnumDateFormatsExW(
        Callback lpDateFmtEnumProcEx,   // DATEFMT_ENUMPROCEXW
        int Locale,   // DWORD
        int dwFlags   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun EnumDateFormatsExW = EnumDateFormatsExW(
    lpDateFmtEnumProcEx : Void*,   # DATEFMT_ENUMPROCEXW
    Locale : UInt32,   # DWORD
    dwFlags : 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 EnumDateFormatsExWNative = Int32 Function(Pointer<Void>, Uint32, Uint32);
typedef EnumDateFormatsExWDart = int Function(Pointer<Void>, int, int);
final EnumDateFormatsExW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<EnumDateFormatsExWNative, EnumDateFormatsExWDart>('EnumDateFormatsExW');
// lpDateFmtEnumProcEx : DATEFMT_ENUMPROCEXW -> Pointer<Void>
// Locale : DWORD -> Uint32
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EnumDateFormatsExW(
  lpDateFmtEnumProcEx: Pointer;   // DATEFMT_ENUMPROCEXW
  Locale: DWORD;   // DWORD
  dwFlags: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'EnumDateFormatsExW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

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

関連項目

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