Fungsi GetCalendarInfoEx (winnls.h)

Artikel
08/27/2023

Mengambil informasi tentang kalender untuk lokal yang ditentukan berdasarkan nama.

Catatan Aplikasi harus memanggil fungsi ini disukai ke GetCalendarInfo jika dirancang untuk berjalan hanya di Windows Vista dan yang lebih baru.

Catatan Fungsi ini dapat mengambil data yang berubah di antara rilis, misalnya, karena lokal kustom. Jika aplikasi Anda harus mempertahankan atau mengirimkan data, lihat Menggunakan Data Lokal Persisten.

Sintaks

int GetCalendarInfoEx(
  [in, optional]  LPCWSTR lpLocaleName,
  [in]            CALID   Calendar,
  [in, optional]  LPCWSTR lpReserved,
  [in]            CALTYPE CalType,
  [out, optional] LPWSTR  lpCalData,
  [in]            int     cchData,
  [out, optional] LPDWORD lpValue
);

Parameter

[in, optional] lpLocaleName

Arahkan ke nama lokal, atau salah satu nilai yang telah ditentukan sebelumnya berikut ini.

[in] Calendar

Pengidentifikasi kalender.

[in, optional] lpReserved

Dipesan; harus NULL.

[in] CalType

Jenis informasi yang akan diambil. Untuk informasi selengkapnya, lihat Informasi Jenis Kalender.

CatatanGetCalendarInfoEx hanya mengembalikan satu string jika parameter ini menentukan CAL_IYEAROFFSETRANGE atau CAL_SERASTRING. Dalam kedua kasus, era saat ini dikembalikan.

Untuk CAL_NOUSEROVERRIDE, fungsi mengabaikan nilai apa pun yang ditetapkan oleh SetCalendarInfo dan menggunakan pengaturan database untuk lokal default sistem saat ini. Jenis ini hanya relevan dalam kombinasi CAL_NOUSEROVERRIDE | CAL_ITWODIGITYEARMAX. CAL_ITWODIGITYEARMAX adalah satu-satunya nilai yang dapat diatur oleh SetCalendarInfo.

[out, optional] lpCalData

Penunjuk ke buffer tempat fungsi ini mengambil data yang diminta sebagai string. Jika CAL_RETURN_NUMBER ditentukan dalam CalType, parameter ini harus mengambil NULL.

[in] cchData

Ukuran, dalam karakter, dari buffer lpCalData . Aplikasi dapat mengatur parameter ini ke 0 untuk mengembalikan ukuran yang diperlukan untuk buffer data kalender. Dalam hal ini, parameter lpCalData tidak digunakan. Jika CAL_RETURN_NUMBER ditentukan untuk CalType, nilai cchData harus 0.

[out, optional] lpValue

Penunjuk ke variabel yang menerima data yang diminta sebagai angka. Jika CAL_RETURN_NUMBER ditentukan dalam CalType, maka lpValue tidak boleh NULL. Jika CAL_RETURN_NUMBER tidak ditentukan dalam CalType, maka lpValue harus NULL.

Mengembalikan nilai

Mengembalikan jumlah karakter yang diambil dalam buffer lpCalData jika berhasil. Jika fungsi berhasil, cchData diatur ke 0, dan CAL_RETURN_NUMBER tidak ditentukan, nilai yang dikembalikan adalah ukuran buffer yang diperlukan untuk menyimpan informasi lokal. Jika fungsi berhasil, cchData diatur ke 0, dan CAL_RETURN_NUMBER ditentukan, nilai yang dikembalikan adalah ukuran nilai yang ditulis ke parameter lpValue . Ukuran ini selalu 2.

Fungsi mengembalikan 0 jika tidak berhasil. Untuk mendapatkan informasi kesalahan yang diperluas, aplikasi dapat memanggil GetLastError, yang dapat mengembalikan salah satu kode kesalahan berikut:

ERROR_INSUFFICIENT_BUFFER. Ukuran buffer yang disediakan tidak cukup besar, atau salah diatur ke NULL.
ERROR_INVALID_FLAGS. Nilai yang diberikan untuk bendera tidak valid.
ERROR_INVALID_PARAMETER. Salah satu nilai parameter tidak valid.

Keterangan

Catatan API ini sedang diperbarui untuk mendukung perubahan era Jepang Mei 2019. Jika aplikasi Anda mendukung kalender Jepang, Anda harus memvalidasi bahwa aplikasi tersebut menangani era baru dengan benar. Lihat Menyiapkan aplikasi Anda untuk perubahan era Jepang untuk informasi selengkapnya.

Dimulai di Windows 8: Jika aplikasi Anda meneruskan tag bahasa ke fungsi ini dari namespace Windows.Globalization , aplikasi harus terlebih dahulu mengonversi tag dengan memanggil ResolveLocaleName.

Persyaratan


Klien minimum yang didukung	Windows Vista [aplikasi desktop \| Aplikasi UWP]
Server minimum yang didukung	Windows 2000 Server [aplikasi desktop \| Aplikasi UWP]
Target Platform	Windows
Header	winnls.h (termasuk Windows.h)
Pustaka	Kernel32.lib
DLL	Kernel32.dll