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

EnumDateFormatsW

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

シグネチャ

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

BOOL EnumDateFormatsW(
    DATEFMT_ENUMPROCW lpDateFmtEnumProc,
    DWORD Locale,
    DWORD dwFlags
);

パラメーター

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

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

dwFlagsDWORDin日付形式を指定するフラグです。詳細な定義については、EnumDateFormatsExExdwFlags パラメーターを参照してください。

戻り値の型: BOOL

公式ドキュメント

指定したロケールで利用できる長い日付形式、短い日付形式、または年月形式を列挙します。(Unicode)

戻り値

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

解説(Remarks)

この API は、2019 年 5 月の日本の元号変更に対応するために更新されています。アプリケーションが日本語カレンダーをサポートしている場合は、新しい元号が正しく処理されることを検証する必要があります。詳細については、日本の元号変更に向けたアプリケーションの準備を参照してください。
この関数の動作の詳細については、EnumDateFormatsEx の「解説」を参照してください。
代替カレンダーを持つロケールの日付形式を列挙するには、アプリケーションは EnumDateFormatsEx を使用してください。
メモ

winnls.h ヘッダーは EnumDateFormats をエイリアスとして定義し、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 EnumDateFormatsW(
    DATEFMT_ENUMPROCW lpDateFmtEnumProc,
    DWORD Locale,
    DWORD dwFlags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool EnumDateFormatsW(
    IntPtr lpDateFmtEnumProc,   // DATEFMT_ENUMPROCW
    uint Locale,   // DWORD
    uint dwFlags   // DWORD
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EnumDateFormatsW(
    lpDateFmtEnumProc As IntPtr,   ' DATEFMT_ENUMPROCW
    Locale As UInteger,   ' DWORD
    dwFlags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpDateFmtEnumProc : DATEFMT_ENUMPROCW
' Locale : DWORD
' dwFlags : DWORD
Declare PtrSafe Function EnumDateFormatsW Lib "kernel32" ( _
    ByVal lpDateFmtEnumProc 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

EnumDateFormatsW = ctypes.windll.kernel32.EnumDateFormatsW
EnumDateFormatsW.restype = wintypes.BOOL
EnumDateFormatsW.argtypes = [
    ctypes.c_void_p,  # lpDateFmtEnumProc : DATEFMT_ENUMPROCW
    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')
EnumDateFormatsW = Fiddle::Function.new(
  lib['EnumDateFormatsW'],
  [
    Fiddle::TYPE_VOIDP,  # lpDateFmtEnumProc : DATEFMT_ENUMPROCW
    -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 EnumDateFormatsW(
        lpDateFmtEnumProc: *const core::ffi::c_void,  // DATEFMT_ENUMPROCW
        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 EnumDateFormatsW(IntPtr lpDateFmtEnumProc, uint Locale, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_EnumDateFormatsW' -Namespace Win32 -PassThru
# $api::EnumDateFormatsW(lpDateFmtEnumProc, Locale, dwFlags)
#uselib "KERNEL32.dll"
#func global EnumDateFormatsW "EnumDateFormatsW" wptr, wptr, wptr
; EnumDateFormatsW lpDateFmtEnumProc, Locale, dwFlags   ; 戻り値は stat
; lpDateFmtEnumProc : DATEFMT_ENUMPROCW -> "wptr"
; Locale : DWORD -> "wptr"
; dwFlags : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global EnumDateFormatsW "EnumDateFormatsW" sptr, int, int
; res = EnumDateFormatsW(lpDateFmtEnumProc, Locale, dwFlags)
; lpDateFmtEnumProc : DATEFMT_ENUMPROCW -> "sptr"
; Locale : DWORD -> "int"
; dwFlags : DWORD -> "int"
; BOOL EnumDateFormatsW(DATEFMT_ENUMPROCW lpDateFmtEnumProc, DWORD Locale, DWORD dwFlags)
#uselib "KERNEL32.dll"
#cfunc global EnumDateFormatsW "EnumDateFormatsW" intptr, int, int
; res = EnumDateFormatsW(lpDateFmtEnumProc, Locale, dwFlags)
; lpDateFmtEnumProc : DATEFMT_ENUMPROCW -> "intptr"
; Locale : DWORD -> "int"
; dwFlags : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procEnumDateFormatsW = kernel32.NewProc("EnumDateFormatsW")
)

// lpDateFmtEnumProc (DATEFMT_ENUMPROCW), Locale (DWORD), dwFlags (DWORD)
r1, _, err := procEnumDateFormatsW.Call(
	uintptr(lpDateFmtEnumProc),
	uintptr(Locale),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function EnumDateFormatsW(
  lpDateFmtEnumProc: Pointer;   // DATEFMT_ENUMPROCW
  Locale: DWORD;   // DWORD
  dwFlags: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'EnumDateFormatsW';
result := DllCall("KERNEL32\EnumDateFormatsW"
    , "Ptr", lpDateFmtEnumProc   ; DATEFMT_ENUMPROCW
    , "UInt", Locale   ; DWORD
    , "UInt", dwFlags   ; DWORD
    , "Int")   ; return: BOOL
●EnumDateFormatsW(lpDateFmtEnumProc, Locale, dwFlags) = DLL("KERNEL32.dll", "bool EnumDateFormatsW(void*, dword, dword)")
# 呼び出し: EnumDateFormatsW(lpDateFmtEnumProc, Locale, dwFlags)
# lpDateFmtEnumProc : DATEFMT_ENUMPROCW -> "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 EnumDateFormatsW(
    lpDateFmtEnumProc: ?*anyopaque, // DATEFMT_ENUMPROCW
    Locale: u32, // DWORD
    dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc EnumDateFormatsW(
    lpDateFmtEnumProc: pointer,  # DATEFMT_ENUMPROCW
    Locale: uint32,  # DWORD
    dwFlags: uint32  # DWORD
): int32 {.importc: "EnumDateFormatsW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
int EnumDateFormatsW(
    void* lpDateFmtEnumProc,   // DATEFMT_ENUMPROCW
    uint Locale,   // DWORD
    uint dwFlags   // DWORD
);
ccall((:EnumDateFormatsW, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, UInt32),
      lpDateFmtEnumProc, Locale, dwFlags)
# lpDateFmtEnumProc : DATEFMT_ENUMPROCW -> 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 EnumDateFormatsW(
    void* lpDateFmtEnumProc,
    uint32_t Locale,
    uint32_t dwFlags);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.EnumDateFormatsW(lpDateFmtEnumProc, Locale, dwFlags)
-- lpDateFmtEnumProc : DATEFMT_ENUMPROCW
-- 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 EnumDateFormatsW = lib.func('__stdcall', 'EnumDateFormatsW', 'int32_t', ['void *', 'uint32_t', 'uint32_t']);
// EnumDateFormatsW(lpDateFmtEnumProc, Locale, dwFlags)
// lpDateFmtEnumProc : DATEFMT_ENUMPROCW -> '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", {
  EnumDateFormatsW: { parameters: ["pointer", "u32", "u32"], result: "i32" },
});
// lib.symbols.EnumDateFormatsW(lpDateFmtEnumProc, Locale, dwFlags)
// lpDateFmtEnumProc : DATEFMT_ENUMPROCW -> "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 EnumDateFormatsW(
    void* lpDateFmtEnumProc,
    uint32_t Locale,
    uint32_t dwFlags);
C, "KERNEL32.dll");
// $ffi->EnumDateFormatsW(lpDateFmtEnumProc, Locale, dwFlags);
// lpDateFmtEnumProc : DATEFMT_ENUMPROCW
// 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 EnumDateFormatsW(
        Callback lpDateFmtEnumProc,   // DATEFMT_ENUMPROCW
        int Locale,   // DWORD
        int dwFlags   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun EnumDateFormatsW = EnumDateFormatsW(
    lpDateFmtEnumProc : Void*,   # DATEFMT_ENUMPROCW
    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 EnumDateFormatsWNative = Int32 Function(Pointer<Void>, Uint32, Uint32);
typedef EnumDateFormatsWDart = int Function(Pointer<Void>, int, int);
final EnumDateFormatsW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<EnumDateFormatsWNative, EnumDateFormatsWDart>('EnumDateFormatsW');
// lpDateFmtEnumProc : DATEFMT_ENUMPROCW -> Pointer<Void>
// Locale : DWORD -> Uint32
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EnumDateFormatsW(
  lpDateFmtEnumProc: Pointer;   // DATEFMT_ENUMPROCW
  Locale: DWORD;   // DWORD
  dwFlags: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'EnumDateFormatsW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let enumdateformatsw =
  foreign "EnumDateFormatsW"
    ((ptr void) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* lpDateFmtEnumProc : DATEFMT_ENUMPROCW -> (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 ("EnumDateFormatsW" enum-date-formats-w :convention :stdcall) :int32
  (lp-date-fmt-enum-proc :pointer)   ; DATEFMT_ENUMPROCW
  (locale :uint32)   ; DWORD
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EnumDateFormatsW = Win32::API::More->new('KERNEL32',
    'BOOL EnumDateFormatsW(LPVOID lpDateFmtEnumProc, DWORD Locale, DWORD dwFlags)');
# my $ret = $EnumDateFormatsW->Call($lpDateFmtEnumProc, $Locale, $dwFlags);
# lpDateFmtEnumProc : DATEFMT_ENUMPROCW -> 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
使用する型