Fungsi GetCurrencyFormatEx (winnls.h)

Artikel
08/27/2023

Memformat string angka sebagai string mata uang untuk lokal yang ditentukan oleh nama.

Catatan Aplikasi harus memanggil fungsi ini sebagai preferensi ke GetCurrencyFormat jika dirancang untuk berjalan hanya pada Windows Vista dan yang lebih baru.

Catatan Fungsi ini dapat memformat 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 GetCurrencyFormatEx(
  [in, optional]  LPCWSTR            lpLocaleName,
  [in]            DWORD              dwFlags,
  [in]            LPCWSTR            lpValue,
  [in, optional]  const CURRENCYFMTW *lpFormat,
  [out, optional] LPWSTR             lpCurrencyStr,
  [in]            int                cchCurrency
);

Parameter

[in, optional] lpLocaleName

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

[in] dwFlags

Bendera yang mengontrol pengoperasian fungsi. Aplikasi harus mengatur parameter ini ke 0 jika lpFormat tidak diatur ke NULL. Dalam hal ini, fungsi memformat string menggunakan penimpaan pengguna ke format mata uang default untuk lokal. Jika lpFormat diatur ke NULL, aplikasi dapat menentukan LOCALE_NOUSEROVERRIDE untuk memformat string menggunakan format mata uang default sistem untuk lokal yang ditentukan.

Hati Penggunaan LOCALE_NOUSEROVERRIDE sangat tidak disarankan karena menonaktifkan preferensi pengguna.

[in] lpValue

Penunjuk ke string yang dihentikan null yang berisi string angka yang akan diformat. String ini hanya dapat berisi karakter berikut. Semua karakter lainnya tidak valid. Fungsi mengembalikan kesalahan jika string menyimpang dari aturan ini.

Karakter "0" hingga "9"
Satu titik desimal (titik) jika angkanya adalah nilai floating-point
Tanda minus di posisi karakter pertama jika angkanya adalah nilai negatif

[in, optional] lpFormat

Penunjuk ke struktur CURRENCYFMT yang berisi informasi pemformatan mata uang. Semua anggota struktur harus berisi nilai yang sesuai. Aplikasi dapat mengatur parameter ini ke NULL jika fungsi adalah menggunakan format mata uang dari lokal yang ditentukan. Jika parameter ini tidak diatur ke NULL, fungsi menggunakan lokal yang ditentukan hanya untuk informasi pemformatan yang tidak ditentukan dalam struktur CURRENCYFMT , misalnya, nilai string untuk tanda negatif yang digunakan oleh lokal.

[out, optional] lpCurrencyStr

Penunjuk ke buffer tempat fungsi ini mengambil string mata uang yang diformat.

[in] cchCurrency

Ukuran, dalam karakter, dari buffer lpCurrencyStr . Aplikasi dapat mengatur parameter ini ke 0 untuk mengembalikan ukuran buffer yang diperlukan untuk menahan string mata uang yang diformat. Dalam hal ini, buffer yang ditunjukkan oleh lpCurrencyStr tidak digunakan.

Mengembalikan nilai

Mengembalikan jumlah karakter yang diambil dalam buffer yang ditunjukkan oleh lpCurrencyStr jika berhasil. Jika parameter cchCurrency adalah 0, fungsi mengembalikan ukuran buffer yang diperlukan untuk menahan string mata uang 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 disediakan untuk bendera tidak valid.
ERROR_INVALID_PARAMETER. Salah satu nilai parameter tidak valid.

Keterangan

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 2000 Professional [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