Fungsi GetCalendarDateFormatEx

Artikel
06/13/2023

Dihentikan. Mengambil string tanggal yang diformat dengan benar untuk lokal yang ditentukan menggunakan tanggal dan kalender yang ditentukan. Pengguna dapat menentukan format tanggal pendek, format tanggal panjang, format bulan tahun, atau pola format kustom.

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

BOOL GetCalendarDateFormatEx(
  _In_        LPCWSTR       lpszLocale,
  _In_        DWORD         dwFlags,
  _In_  const LPCALDATETIME lpCalDateTime,
  _In_        LPCWSTR       lpFormat,
  _Out_       LPWSTR        lpDateStr,
  _In_        int           cchDate
);

Parameter

lpszLocale [in]

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

dwFlags [in]

Bendera yang menentukan opsi format tanggal. Jika lpFormat tidak diatur ke NULL, parameter ini harus diatur ke 0. Jika lpFormat diatur ke NULL, aplikasi dapat menentukan kombinasi nilai dan LOCALE_NOUSEROVERRIDE berikut.

Nilai	Makna
DATE_SHORTDATE	Gunakan format tanggal pendek. Ini adalah default. Nilai ini tidak dapat digunakan dengan DATE_LONGDATE atau DATE_YEARMONTH.
DATE_LONGDATE	Gunakan format tanggal panjang. Nilai ini tidak dapat digunakan dengan DATE_SHORTDATE atau DATE_YEARMONTH.
DATE_YEARMONTH	Gunakan format tahun/bulan. Nilai ini tidak dapat digunakan dengan DATE_SHORTDATE atau DATE_LONGDATE.
DATE_LTRREADING	Tambahkan tanda untuk tata letak baca kiri-ke-kanan. Nilai ini tidak dapat digunakan dengan DATE_RTLREADING.
DATE_RTLREADING	Tambahkan tanda untuk tata letak baca kanan-ke-kiri. Nilai ini tidak dapat digunakan dengan DATE_LTRREADING

lpCalDateTime [in]

Penunjuk ke struktur CALDATETIME yang berisi informasi tanggal dan kalender untuk diformat.

lpFormat [in]

Penunjuk ke string gambar format yang digunakan untuk membentuk string tanggal. Nilai yang mungkin untuk format string gambar ditentukan dalam Gambar Format Hari, Bulan, Tahun, dan Era.

String gambar format harus dihentikan null. Fungsi ini menggunakan lokal hanya untuk informasi yang tidak ditentukan dalam string gambar format, misalnya, nama hari dan bulan untuk lokal. Aplikasi mengatur parameter ini ke NULL jika fungsinya adalah menggunakan format tanggal lokal yang ditentukan.

lpDateStr [out]

Penunjuk ke buffer tempat fungsi ini menerima string tanggal yang diformat.

cchDate [in]

Ukuran, dalam karakter, dari buffer lpDateStr . Atau, aplikasi dapat mengatur parameter ini ke 0. Dalam hal ini, fungsi mengembalikan jumlah karakter yang diperlukan untuk menahan string tanggal yang diformat, dan parameter lpDateStr tidak digunakan.

Menampilkan nilai

Mengembalikan jumlah karakter yang ditulis ke buffer lpDateStr jika berhasil. Jika parameter cchDate diatur ke 0, fungsi mengembalikan jumlah karakter yang diperlukan untuk menahan string tanggal yang diformat, termasuk karakter null yang mengakhiri.

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

ERROR_DATE_OUT_OF_RANGE. Tanggal yang ditentukan di luar rentang.
ERROR_INSUFFICIENT_BUFFER. Ukuran buffer yang disediakan tidak cukup besar, atau salah diatur ke NULL.
ERROR_INVALID_FLAGS. Nilai yang disediakan untuk bendera tidak valid.
ERROR_INVALID_PARAMETER. Salah satu nilai parameter tidak valid.

Keterangan

Tanggal paling awal yang didukung oleh fungsi ini adalah 1 Januari 1601.

Fungsi ini tidak memiliki file header atau file pustaka terkait. Aplikasi dapat memanggil LoadLibrary dengan nama DLL (Kernel32.dll) untuk mendapatkan handel modul. Kemudian dapat memanggil GetProcAddress dengan handel modul dan nama fungsi ini untuk mendapatkan alamat fungsi.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows Vista [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2008 [hanya aplikasi desktop]
DLL	Kernel32.dll

Lihat juga

Dukungan Bahasa Nasional
Fungsi Dukungan Bahasa Nasional
Gambar Format Hari, Bulan, Tahun, dan Era
NLS: Sampel API berbasis nama
EnumDateFormatsExEx
GetDateFormat
GetDateFormatEx
CALDATETIME

Bagikan melalui