GetCalendarInfoW

関数

指定ロケールと暦のカレンダー情報を取得する。Unicode版。

DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

INT GetCalendarInfoW(
    DWORD Locale,
    DWORD Calendar,
    DWORD CalType,
    LPWSTR lpCalData,   // optional
    INT cchData,
    DWORD* lpValue   // optional
);

パラメーター

名前	型	方向	説明
Locale	DWORD	in	カレンダー情報を取得する対象のロケールを指定するロケール識別子です。MAKELCID マクロを使用してロケール識別子を作成するか、次の定義済み値のいずれかを使用できます。 LOCALE_CUSTOM_DEFAULT LOCALE_CUSTOM_UI_DEFAULT LOCALE_CUSTOM_UNSPECIFIED LOCALE_INVARIANT LOCALE_SYSTEM_DEFAULT LOCALE_USER_DEFAULT
Calendar	DWORD	in	カレンダー識別子です。
CalType	DWORD	in	取得する情報の種類です。詳細については、Calendar Type Information を参照してください。注意このパラメーターに CAL_IYEAROFFSETRANGE または CAL_SERASTRING を指定した場合、GetCalendarInfo は 1 つの文字列のみを返します。いずれの場合も、現在の元号が返されます。 CAL_USE_CP_ACP は、この関数の ANSI 版でのみ意味を持ちます。 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

公式ドキュメント

識別子で指定されたロケールのカレンダーに関する情報を取得します。(Unicode)

戻り値

成功した場合、cchData を 0 以外の値に設定すると、lpCalData バッファーに取得された文字数を返します。関数が成功し、cchData が 0 に設定され、CAL_RETURN_NUMBER が指定されていない場合、戻り値はカレンダー情報を格納するために必要なバッファーのサイズです。関数が成功し、cchData が 0 に設定され、CAL_RETURN_NUMBER が指定されている場合、戻り値は lpValue に取得される値のサイズ、すなわち、この関数の Unicode 版では 2、ANSI 版では 4 です。

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

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

解説(Remarks)

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

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

INT GetCalendarInfoW(
    DWORD Locale,
    DWORD Calendar,
    DWORD CalType,
    LPWSTR lpCalData,   // optional
    INT cchData,
    DWORD* lpValue   // optional
);

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

<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetCalendarInfoW(
    Locale As UInteger,   ' DWORD
    Calendar As UInteger,   ' DWORD
    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

' Locale : DWORD
' Calendar : DWORD
' CalType : DWORD
' lpCalData : LPWSTR optional, out
' cchData : INT
' lpValue : DWORD* optional, out
Declare PtrSafe Function GetCalendarInfoW Lib "kernel32" ( _
    ByVal Locale As Long, _
    ByVal Calendar As Long, _
    ByVal CalType As Long, _
    ByVal lpCalData As LongPtr, _
    ByVal cchData As Long, _
    ByVal lpValue As LongPtr) 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

GetCalendarInfoW = ctypes.windll.kernel32.GetCalendarInfoW
GetCalendarInfoW.restype = ctypes.c_int
GetCalendarInfoW.argtypes = [
    wintypes.DWORD,  # Locale : DWORD
    wintypes.DWORD,  # Calendar : DWORD
    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')
GetCalendarInfoW = Fiddle::Function.new(
  lib['GetCalendarInfoW'],
  [
    -Fiddle::TYPE_INT,  # Locale : DWORD
    -Fiddle::TYPE_INT,  # Calendar : DWORD
    -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)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "kernel32")]
extern "system" {
    fn GetCalendarInfoW(
        Locale: u32,  // DWORD
        Calendar: u32,  // DWORD
        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", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern int GetCalendarInfoW(uint Locale, uint Calendar, uint CalType, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpCalData, int cchData, IntPtr lpValue);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetCalendarInfoW' -Namespace Win32 -PassThru
# $api::GetCalendarInfoW(Locale, Calendar, CalType, lpCalData, cchData, lpValue)

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

出力引数:

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