GetCalendarInfoEx

関数

ロケール名を指定してカレンダー情報を取得する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

INT GetCalendarInfoEx(
    LPCWSTR lpLocaleName,   // optional
    DWORD Calendar,
    LPCWSTR lpReserved,   // optional
    DWORD CalType,
    LPWSTR lpCalData,   // optional
    INT cchData,
    DWORD* lpValue   // optional
);

パラメーター

名前	型	方向	説明
lpLocaleName	LPCWSTR	inoptional	ロケール名へのポインター、または次の定義済みの値のいずれかです。 LOCALE_NAME_INVARIANT LOCALE_NAME_SYSTEM_DEFAULT LOCALE_NAME_USER_DEFAULT
Calendar	DWORD	in	カレンダー識別子です。
lpReserved	LPCWSTR	inoptional	予約済みです。NULL である必要があります。
CalType	DWORD	in	取得する情報の種類です。詳細については、Calendar Type Information を参照してください。注意このパラメーターに CAL_IYEAROFFSETRANGE または CAL_SERASTRING を指定した場合、GetCalendarInfoEx は 1 つの文字列のみを返します。いずれの場合も、現在の元号が返されます。 CAL_NOUSEROVERRIDE の場合、この関数は SetCalendarInfo によって設定された値を無視し、現在のシステム既定ロケールに対するデータベースの設定を使用します。この種類は、CAL_NOUSEROVERRIDE \| CAL_ITWODIGITYEARMAX という組み合わせでのみ意味を持ちます。CAL_ITWODIGITYEARMAX は、SetCalendarInfo によって設定できる唯一の値です。
lpCalData	LPWSTR	outoptional	この関数が要求されたデータを文字列として取得するバッファーへのポインターです。CalType に CAL_RETURN_NUMBER が指定されている場合、このパラメーターには NULL を取得する必要があります。
cchData	INT	in	lpCalData バッファーのサイズ(文字数)です。アプリケーションは、このパラメーターを 0 に設定して、カレンダーデータバッファーに必要なサイズを返すことができます。この場合、lpCalData パラメーターは使用されません。CalType に CAL_RETURN_NUMBER が指定されている場合、cchData の値は 0 でなければなりません。
lpValue	DWORD*	outoptional	要求されたデータを数値として受け取る変数へのポインターです。CalType に CAL_RETURN_NUMBER が指定されている場合、lpValue は NULL であってはなりません。CalType に CAL_RETURN_NUMBER が指定されていない場合、lpValue は NULL でなければなりません。

戻り値の型: INT

公式ドキュメント

名前で指定されたロケールのカレンダーに関する情報を取得します。注意アプリケーションが Windows Vista 以降でのみ動作するように設計されている場合は、GetCalendarInfo よりもこの関数を優先して呼び出す必要があります。注意この関数は、たとえばカスタムロケールなどによってリリース間で変化するデータを取得することがあります。アプリケーションがデータを永続化または送信する必要がある場合は、「Using Persistent Locale Data」を参照してください。

戻り値

成功した場合、lpCalData バッファーに取得された文字数を返します。関数が成功し、cchData が 0 に設定されており、CAL_RETURN_NUMBER が指定されていない場合、戻り値はロケール情報を保持するために必要なバッファーのサイズです。関数が成功し、cchData が 0 に設定されており、CAL_RETURN_NUMBER が指定されている場合、戻り値は lpValue パラメーターに書き込まれた値のサイズです。このサイズは常に 2 です。

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

ERROR_INSUFFICIENT_BUFFER。指定されたバッファーサイズが十分な大きさではなかったか、誤って NULL に設定されていました。
ERROR_INVALID_FLAGS。フラグに指定された値が無効でした。
ERROR_INVALID_PARAMETER。いずれかのパラメーター値が無効でした。

解説(Remarks)

注意この API は、2019 年 5 月の日本の元号変更に対応するために更新されています。アプリケーションが和暦をサポートしている場合は、新しい元号を正しく処理できることを検証する必要があります。詳細については、Prepare your application for the Japanese era change を参照してください。

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>

INT GetCalendarInfoEx(
    LPCWSTR lpLocaleName,   // optional
    DWORD Calendar,
    LPCWSTR lpReserved,   // optional
    DWORD CalType,
    LPWSTR lpCalData,   // optional
    INT cchData,
    DWORD* lpValue   // optional
);

[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern int GetCalendarInfoEx(
    [MarshalAs(UnmanagedType.LPWStr)] string lpLocaleName,   // LPCWSTR optional
    uint Calendar,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string lpReserved,   // LPCWSTR optional
    uint CalType,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpCalData,   // LPWSTR optional, out
    int cchData,   // INT
    IntPtr lpValue   // DWORD* optional, out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetCalendarInfoEx(
    <MarshalAs(UnmanagedType.LPWStr)> lpLocaleName As String,   ' LPCWSTR optional
    Calendar As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpReserved As String,   ' LPCWSTR optional
    CalType As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpCalData As System.Text.StringBuilder,   ' LPWSTR optional, out
    cchData As Integer,   ' INT
    lpValue As IntPtr   ' DWORD* optional, out
) As Integer
End Function

' lpLocaleName : LPCWSTR optional
' Calendar : DWORD
' lpReserved : LPCWSTR optional
' CalType : DWORD
' lpCalData : LPWSTR optional, out
' cchData : INT
' lpValue : DWORD* optional, out
Declare PtrSafe Function GetCalendarInfoEx Lib "kernel32" ( _
    ByVal lpLocaleName As LongPtr, _
    ByVal Calendar As Long, _
    ByVal lpReserved As LongPtr, _
    ByVal CalType As Long, _
    ByVal lpCalData As LongPtr, _
    ByVal cchData As Long, _
    ByVal lpValue As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetCalendarInfoEx = ctypes.windll.kernel32.GetCalendarInfoEx
GetCalendarInfoEx.restype = ctypes.c_int
GetCalendarInfoEx.argtypes = [
    wintypes.LPCWSTR,  # lpLocaleName : LPCWSTR optional
    wintypes.DWORD,  # Calendar : DWORD
    wintypes.LPCWSTR,  # lpReserved : LPCWSTR optional
    wintypes.DWORD,  # CalType : DWORD
    wintypes.LPWSTR,  # lpCalData : LPWSTR optional, out
    ctypes.c_int,  # cchData : INT
    ctypes.POINTER(wintypes.DWORD),  # lpValue : DWORD* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetCalendarInfoEx = Fiddle::Function.new(
  lib['GetCalendarInfoEx'],
  [
    Fiddle::TYPE_VOIDP,  # lpLocaleName : LPCWSTR optional
    -Fiddle::TYPE_INT,  # Calendar : DWORD
    Fiddle::TYPE_VOIDP,  # lpReserved : LPCWSTR optional
    -Fiddle::TYPE_INT,  # CalType : DWORD
    Fiddle::TYPE_VOIDP,  # lpCalData : LPWSTR optional, out
    Fiddle::TYPE_INT,  # cchData : INT
    Fiddle::TYPE_VOIDP,  # lpValue : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetCalendarInfoEx(
        lpLocaleName: *const u16,  // LPCWSTR optional
        Calendar: u32,  // DWORD
        lpReserved: *const u16,  // LPCWSTR optional
        CalType: u32,  // DWORD
        lpCalData: *mut u16,  // LPWSTR optional, out
        cchData: i32,  // INT
        lpValue: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern int GetCalendarInfoEx([MarshalAs(UnmanagedType.LPWStr)] string lpLocaleName, uint Calendar, [MarshalAs(UnmanagedType.LPWStr)] string lpReserved, uint CalType, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpCalData, int cchData, IntPtr lpValue);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetCalendarInfoEx' -Namespace Win32 -PassThru
# $api::GetCalendarInfoEx(lpLocaleName, Calendar, lpReserved, CalType, lpCalData, cchData, lpValue)

#uselib "KERNEL32.dll"
#func global GetCalendarInfoEx "GetCalendarInfoEx" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; GetCalendarInfoEx lpLocaleName, Calendar, lpReserved, CalType, varptr(lpCalData), cchData, varptr(lpValue)   ; 戻り値は stat
; lpLocaleName : LPCWSTR optional -> "sptr"
; Calendar : DWORD -> "sptr"
; lpReserved : LPCWSTR optional -> "sptr"
; CalType : DWORD -> "sptr"
; lpCalData : LPWSTR optional, out -> "sptr"
; cchData : INT -> "sptr"
; lpValue : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetCalendarInfoEx "GetCalendarInfoEx" wstr, int, wstr, int, var, int, var
; res = GetCalendarInfoEx(lpLocaleName, Calendar, lpReserved, CalType, lpCalData, cchData, lpValue)
; lpLocaleName : LPCWSTR optional -> "wstr"
; Calendar : DWORD -> "int"
; lpReserved : LPCWSTR optional -> "wstr"
; CalType : DWORD -> "int"
; lpCalData : LPWSTR optional, out -> "var"
; cchData : INT -> "int"
; lpValue : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetCalendarInfoEx "GetCalendarInfoEx" wstr, int, wstr, int, sptr, int, sptr
; res = GetCalendarInfoEx(lpLocaleName, Calendar, lpReserved, CalType, varptr(lpCalData), cchData, varptr(lpValue))
; lpLocaleName : LPCWSTR optional -> "wstr"
; Calendar : DWORD -> "int"
; lpReserved : LPCWSTR optional -> "wstr"
; CalType : DWORD -> "int"
; lpCalData : LPWSTR optional, out -> "sptr"
; cchData : INT -> "int"
; lpValue : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。