Fungsi GetCurrencyFormatA (winnls.h)

Artikel
08/27/2023

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

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

Sintaks

int GetCurrencyFormatA(
  [in]            LCID               Locale,
  [in]            DWORD              dwFlags,
  [in]            LPCSTR             lpValue,
  [in, optional]  const CURRENCYFMTA *lpFormat,
  [out, optional] LPSTR              lpCurrencyStr,
  [in]            int                cchCurrency
);

Parameter

[in] Locale

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

[in] dwFlags

Bendera yang mengontrol format mata uang. 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

Untuk detailnya, lihat parameter lpValue dari GetCurrencyFormatEx.

[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 mengatur parameter ini ke 0 jika fungsinya adalah mengembalikan ukuran buffer yang diperlukan untuk menahan string mata uang yang diformat. Dalam hal ini, parameter lpCurrencyStr tidak digunakan.

Mengembalikan nilai

Mengembalikan jumlah karakter yang diambil dalam buffer yang ditunjukkan oleh lpCurrencyStr jika berhasil. Jika parameter cchCurrency diatur ke 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 diberikan untuk bendera tidak valid.
ERROR_INVALID_PARAMETER. Salah satu nilai parameter tidak valid.

Keterangan

Fungsi ini dapat mengambil data dari lokal kustom. Data tidak dijamin sama dari komputer ke komputer atau antara eksekusi aplikasi. Jika aplikasi Anda harus mempertahankan atau mengirimkan data, lihat Menggunakan Data Lokal Persisten.

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

Catatan

Header winnls.h mendefinisikan GetCurrencyFormat 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	winnls.h (termasuk Windows.h)
Pustaka	Kernel32.lib
DLL	Kernel32.dll