Fungsi GetDateFormatW (datetimeapi.h)

Artikel
08/23/2023

Memformat tanggal sebagai string tanggal untuk lokal yang ditentukan oleh pengidentifikasi lokal. Fungsi memformat tanggal yang ditentukan atau tanggal sistem lokal.

Catatan Untuk alasan interoperabilitas, aplikasi harus lebih memilih fungsi GetDateFormatEx ke GetDateFormat karena Microsoft bermigrasi ke penggunaan nama lokal alih-alih pengidentifikasi lokal untuk lokal baru. Aplikasi apa pun yang hanya akan dijalankan di Windows Vista dan nantinya harus menggunakan GetDateFormatEx.

Sintaks

int GetDateFormatW(
  [in]            LCID             Locale,
  [in]            DWORD            dwFlags,
  [in, optional]  const SYSTEMTIME *lpDate,
  [in, optional]  LPCWSTR          lpFormat,
  [out, optional] LPWSTR           lpDateStr,
  [in]            int              cchDate
);

Parameter

[in] Locale

Pengidentifikasi lokal yang menentukan lokal fungsi ini memformat string tanggal. Anda bisa menggunakan makro MAKELCID untuk membuat pengidentifikasi lokal atau menggunakan salah satu nilai yang telah ditentukan sebelumnya berikut ini.

[in] dwFlags

Bendera yang menentukan opsi format tanggal. Untuk definisi terperinci, lihat parameter dwFlags dari GetDateFormatEx.

[in, optional] lpDate

Penunjuk ke struktur SYSTEMTIME yang berisi informasi tanggal untuk diformat. Aplikasi mengatur parameter ini ke NULL jika fungsinya adalah menggunakan tanggal sistem lokal saat ini.

[in, optional] lpFormat

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

Fungsi ini menggunakan lokal yang ditentukan hanya untuk informasi yang tidak ditentukan dalam format string gambar, misalnya, nama hari dan bulan untuk lokal. Aplikasi dapat mengatur parameter ini ke NULL untuk memformat string sesuai dengan format tanggal untuk lokal yang ditentukan.

[out, optional] lpDateStr

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

[in] cchDate

Ukuran, dalam karakter, dari buffer lpDateStr . Aplikasi dapat mengatur parameter ini ke 0 untuk mengembalikan ukuran buffer yang diperlukan untuk menahan string tanggal yang diformat. Dalam hal ini, buffer yang ditunjukkan oleh 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 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.

Lihat Keterangan untuk GetDateFormatEx.

Ketika versi ANSI dari fungsi ini digunakan dengan pengidentifikasi lokal khusus Unicode, fungsi dapat berhasil karena sistem operasi menggunakan halaman kode sistem. Namun, karakter yang tidak ditentukan di halaman kode sistem muncul dalam string sebagai tanda tanya ("?").

Dimulai dengan Windows 8: GetDateFormat dideklarasikan dalam Datetimeapi.h. Sebelum Windows 8, itu dinyatakan di Winnls.h.

Catatan

Header datetimeapi.h mendefinisikan GetDateFormat sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta pra-prosesor UNICODE. Mencampur penggunaan alias encoding-netral dengan kode yang tidak mengodekan-netral dapat menyebabkan ketidakcocokan yang mengakibatkan kesalahan kompilasi atau runtime. Untuk informasi selengkapnya, lihat Konvensi untuk Prototipe Fungsi.

Persyaratan


Klien minimum yang didukung	Windows 2000 Professional [hanya aplikasi desktop]
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Target Platform	Windows
Header	datetimeapi.h
Pustaka	Kernel32.lib
DLL	Kernel32.dll