fungsi StringCchPrintf_lA (strsafe.h)
Menulis data yang diformat ke string yang ditentukan. Ukuran buffer tujuan disediakan untuk fungsi untuk memastikan bahwa buffer tidak menulis melewati akhir buffer ini.
StringCchPrintf_l mirip dengan StringCchPrintf tetapi menyertakan parameter untuk informasi lokal.
Sintaks
STRSAFEAPI StringCchPrintf_lA(
[out] STRSAFE_LPSTR pszDest,
[in] size_t cchDest,
[in] _Printf_format_string_params_(2)STRSAFE_LPCSTR pszFormat,
[in] _locale_t locale,
...
);
Parameter
[out] pszDest
Buffer tujuan, yang menerima string yang diformat dan dihentikan null yang dibuat dari pszFormat dan argumennya.
[in] cchDest
Ukuran buffer tujuan, dalam karakter. Nilai ini harus cukup besar untuk mengakomodasi string berformat akhir ditambah 1 untuk memperhitungkan karakter null yang mengakhiri. Jumlah maksimum karakter yang diizinkan adalah STRSAFE_MAX_CCH.
[in] pszFormat
String format. String ini harus dihentikan null. Untuk informasi selengkapnya, lihat Format Sintaks Spesifikasi.
[in] locale
Objek lokal. Untuk informasi selengkapnya, lihat _create_locale.
...
Argumen yang akan dimasukkan ke dalam string pszFormat .
Nilai kembali
Fungsi ini dapat mengembalikan salah satu nilai berikut. Sangat disarankan agar Anda menggunakan makro BERHASIL dan GAGAL untuk menguji nilai pengembalian fungsi ini.
Menampilkan kode | Deskripsi |
---|---|
|
Ada cukup ruang untuk hasil yang akan disalin ke pszDest tanpa pemotongan, dan buffer dihentikan null. |
|
Nilai dalam cchDest adalah 0 atau lebih besar dari STRSAFE_MAX_CCH. |
|
Operasi penyalinan gagal karena ruang buffer yang tidak mencukupi. Buffer tujuan berisi versi hasil yang dipotong dan dihentikan null. Dalam situasi di mana pemotongan dapat diterima, ini mungkin belum tentu dianggap sebagai kondisi kegagalan. |
Keterangan
Perilaku tidak terdefinisi jika string yang diarahkan oleh pszDest, pszFormat, atau string argumen apa pun tumpang tindih.
Baik pszFormat maupun pszDest tidak boleh NULL. Lihat StringCchPrintf_lEx jika Anda memerlukan penanganan nilai penunjuk string null.
Untuk menggunakan fungsi ini, Anda harus menentukan makro berikut dalam file header Anda, sebelum menyertakan StrSafe.h.
#define STRSAFE_LOCALE_FUNCTIONS
Catatan
Header strsafe.h mendefinisikan StringCchPrintf_l 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 Vista [aplikasi desktop | Aplikasi UWP] |
Server minimum yang didukung | Windows Server 2008 [aplikasi desktop | Aplikasi UWP] |
Target Platform | Windows |
Header | strsafe.h |