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

EnumDateFormatsA

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

シグネチャ

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

BOOL EnumDateFormatsA(
    DATEFMT_ENUMPROCA lpDateFmtEnumProc,
    DWORD Locale,
    DWORD dwFlags
);

パラメーター

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

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

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

戻り値の型: BOOL

公式ドキュメント

指定したロケールで利用可能な、長い日付形式、短い日付形式、または年/月形式を列挙します。(ANSI)

戻り値

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

解説(Remarks)

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

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 EnumDateFormatsA(
    DATEFMT_ENUMPROCA lpDateFmtEnumProc,
    DWORD Locale,
    DWORD dwFlags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool EnumDateFormatsA(
    IntPtr lpDateFmtEnumProc,   // DATEFMT_ENUMPROCA
    uint Locale,   // DWORD
    uint dwFlags   // DWORD
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EnumDateFormatsA(
    lpDateFmtEnumProc As IntPtr,   ' DATEFMT_ENUMPROCA
    Locale As UInteger,   ' DWORD
    dwFlags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpDateFmtEnumProc : DATEFMT_ENUMPROCA
' Locale : DWORD
' dwFlags : DWORD
Declare PtrSafe Function EnumDateFormatsA Lib "kernel32" ( _
    ByVal lpDateFmtEnumProc 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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procEnumDateFormatsA = kernel32.NewProc("EnumDateFormatsA")
)

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

extern "kernel32" fn EnumDateFormatsA(
    lpDateFmtEnumProc: ?*anyopaque, // DATEFMT_ENUMPROCA
    Locale: u32, // DWORD
    dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc EnumDateFormatsA(
    lpDateFmtEnumProc: pointer,  # DATEFMT_ENUMPROCA
    Locale: uint32,  # DWORD
    dwFlags: uint32  # DWORD
): int32 {.importc: "EnumDateFormatsA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int EnumDateFormatsA(
    void* lpDateFmtEnumProc,   // DATEFMT_ENUMPROCA
    uint Locale,   // DWORD
    uint dwFlags   // DWORD
);
ccall((:EnumDateFormatsA, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, UInt32),
      lpDateFmtEnumProc, Locale, dwFlags)
# lpDateFmtEnumProc : DATEFMT_ENUMPROCA -> Ptr{Cvoid}
# Locale : DWORD -> UInt32
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t EnumDateFormatsA(
    void* lpDateFmtEnumProc,
    uint32_t Locale,
    uint32_t dwFlags);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.EnumDateFormatsA(lpDateFmtEnumProc, Locale, dwFlags)
-- lpDateFmtEnumProc : DATEFMT_ENUMPROCA
-- Locale : DWORD
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const EnumDateFormatsA = lib.func('__stdcall', 'EnumDateFormatsA', 'int32_t', ['void *', 'uint32_t', 'uint32_t']);
// EnumDateFormatsA(lpDateFmtEnumProc, Locale, dwFlags)
// lpDateFmtEnumProc : DATEFMT_ENUMPROCA -> '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", {
  EnumDateFormatsA: { parameters: ["pointer", "u32", "u32"], result: "i32" },
});
// lib.symbols.EnumDateFormatsA(lpDateFmtEnumProc, Locale, dwFlags)
// lpDateFmtEnumProc : DATEFMT_ENUMPROCA -> "pointer"
// Locale : DWORD -> "u32"
// dwFlags : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t EnumDateFormatsA(
    void* lpDateFmtEnumProc,
    uint32_t Locale,
    uint32_t dwFlags);
C, "KERNEL32.dll");
// $ffi->EnumDateFormatsA(lpDateFmtEnumProc, Locale, dwFlags);
// lpDateFmtEnumProc : DATEFMT_ENUMPROCA
// 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.ASCII_OPTIONS);
    boolean EnumDateFormatsA(
        Callback lpDateFmtEnumProc,   // DATEFMT_ENUMPROCA
        int Locale,   // DWORD
        int dwFlags   // DWORD
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun EnumDateFormatsA = EnumDateFormatsA(
    lpDateFmtEnumProc : Void*,   # DATEFMT_ENUMPROCA
    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 EnumDateFormatsANative = Int32 Function(Pointer<Void>, Uint32, Uint32);
typedef EnumDateFormatsADart = int Function(Pointer<Void>, int, int);
final EnumDateFormatsA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<EnumDateFormatsANative, EnumDateFormatsADart>('EnumDateFormatsA');
// lpDateFmtEnumProc : DATEFMT_ENUMPROCA -> Pointer<Void>
// Locale : DWORD -> Uint32
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EnumDateFormatsA(
  lpDateFmtEnumProc: Pointer;   // DATEFMT_ENUMPROCA
  Locale: DWORD;   // DWORD
  dwFlags: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'EnumDateFormatsA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let enumdateformatsa =
  foreign "EnumDateFormatsA"
    ((ptr void) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* lpDateFmtEnumProc : DATEFMT_ENUMPROCA -> (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 ("EnumDateFormatsA" enum-date-formats-a :convention :stdcall) :int32
  (lp-date-fmt-enum-proc :pointer)   ; DATEFMT_ENUMPROCA
  (locale :uint32)   ; DWORD
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EnumDateFormatsA = Win32::API::More->new('KERNEL32',
    'BOOL EnumDateFormatsA(LPVOID lpDateFmtEnumProc, DWORD Locale, DWORD dwFlags)');
# my $ret = $EnumDateFormatsA->Call($lpDateFmtEnumProc, $Locale, $dwFlags);
# lpDateFmtEnumProc : DATEFMT_ENUMPROCA -> LPVOID
# Locale : DWORD -> DWORD
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

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