Fungsi GetDurationFormat (winnls.h)

Artikel
03/08/2023

Memformat durasi waktu sebagai string waktu untuk lokal yang ditentukan oleh pengidentifikasi.

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

Sintaks

int GetDurationFormat(
  [in]            LCID             Locale,
  [in]            DWORD            dwFlags,
  [in, optional]  const SYSTEMTIME *lpDuration,
  [in]            ULONGLONG        ullDuration,
  [in, optional]  LPCWSTR          lpFormat,
  [out, optional] LPWSTR           lpDurationStr,
  [in]            int              cchDuration
);

Parameter

[in] Locale

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

Windows Vista dan yang lebih baru: Pengidentifikasi lokal kustom berikut ini juga didukung.

[in] dwFlags

Bendera yang menentukan opsi fungsi. Jika lpFormat tidak diatur ke NULL, parameter ini harus diatur ke 0. Jika lpFormat diatur ke NULL, aplikasi Anda dapat menentukan LOCALE_NOUSEROVERRIDE untuk memformat string menggunakan format durasi default sistem untuk lokal yang ditentukan.

Hati Penggunaan LOCALE_NOUSEROVERRIDE sangat tidak disarankan karena menonaktifkan preferensi pengguna.

[in, optional] lpDuration

Penunjuk ke struktur SYSTEMTIME yang berisi informasi durasi waktu untuk diformat. Jika pointer ini NULL, fungsi mengabaikan parameter ini dan menggunakan ullDuration.

[in] ullDuration

Bilangan bulat tidak bertanda 64-bit yang menunjukkan jumlah interval 100 nanodetik dalam durasi. Jika lpDuration dan ullDuration ada, lpDuration lebih diutamakan. Jika lpDuration diatur ke NULL dan ullDuration diatur ke 0, durasinya adalah nol.

[in, optional] lpFormat

Arahkan ke string format. Untuk detailnya, lihat parameter lpFormat dari GetDurationFormatEx.

[out, optional] lpDurationStr

Arahkan ke buffer tempat fungsi mengambil string durasi.

Atau, parameter ini dapat berisi NULL jika cchDuration diatur ke 0. Dalam hal ini, fungsi mengembalikan ukuran yang diperlukan untuk buffer string durasi.

[in] cchDuration

Ukuran, dalam karakter, dari buffer yang ditunjukkan oleh lpDurationStr.

Atau, aplikasi dapat mengatur parameter ini ke 0. Dalam hal ini, fungsi mengambil NULL di lpDurationStr dan mengembalikan ukuran yang diperlukan untuk buffer string durasi.

Nilai kembali

Mengembalikan jumlah karakter yang diambil dalam buffer yang ditunjukkan oleh lpDurationStr jika berhasil. Jika lpDurationStr diatur ke NULL dan cchDuration diatur ke 0, fungsi mengembalikan ukuran yang diperlukan untuk buffer string durasi, termasuk karakter penghentian null. Misalnya, jika 10 karakter ditulis ke buffer, fungsi mengembalikan 11 untuk menyertakan 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_PARAMETER. Salah satu nilai parameter tidak valid.

Keterangan

Lihat Keterangan untuk GetDurationFormatEx.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows Vista [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2008 [hanya aplikasi desktop]
Target Platform	Windows
Header	winnls.h (termasuk Windows.h)
Pustaka	Kernel32.lib
DLL	Kernel32.dll