Fungsi GetTimeFormatA (datetimeapi.h)

Artikel
08/23/2023

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

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

Sintaks

int GetTimeFormatA(
  [in]            LCID             Locale,
  [in]            DWORD            dwFlags,
  [in, optional]  const SYSTEMTIME *lpTime,
  [in, optional]  LPCSTR           lpFormat,
  [out, optional] LPSTR            lpTimeStr,
  [in]            int              cchTime
);

Parameter

[in] Locale

Pengidentifikasi lokal yang menentukan lokal. Anda dapat 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 waktu. Untuk definisi terperinci, lihat parameter dwFlags dari GetTimeFormatEx.

[in, optional] lpTime

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

[in, optional] lpFormat

Arahkan ke gambar format yang akan digunakan untuk memformat string waktu. Jika aplikasi mengatur parameter ini ke NULL, fungsi memformat string sesuai dengan format waktu lokal yang ditentukan. Jika aplikasi tidak mengatur parameter ke NULL, fungsi menggunakan lokal hanya untuk informasi yang tidak ditentukan dalam format string gambar, misalnya, penanda waktu khusus lokal. Untuk informasi tentang format string gambar, lihat bagian Keterangan.

[out, optional] lpTimeStr

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

[in] cchTime

Ukuran, dalam nilai TCHAR, untuk buffer string waktu yang ditunjukkan oleh lpTimeStr. Atau, aplikasi dapat mengatur parameter ini ke 0. Dalam hal ini, fungsi mengembalikan ukuran yang diperlukan untuk buffer string waktu, dan tidak menggunakan parameter lpTimeStr .

Mengembalikan nilai

Mengembalikan jumlah nilai TCHAR yang diambil dalam buffer yang ditunjukkan oleh lpTimeStr. Jika parameter cchTime diatur ke 0, fungsi mengembalikan ukuran buffer yang diperlukan untuk menahan string waktu 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_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.
ERROR_OUTOFMEMORY. Penyimpanan tidak cukup tersedia untuk menyelesaikan operasi ini.

Keterangan

Lihat Keterangan untuk GetTimeFormatEx.

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: GetTimeFormat dideklarasikan dalam Datetimeapi.h. Sebelum Windows 8, itu dinyatakan di Winnls.h.

Catatan

Header datetimeapi.h mendefinisikan GetTimeFormat 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

Persyaratan	Nilai
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