Fungsi StringCchPrintfA (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 adalah pengganti untuk fungsi berikut:
Sintaks
STRSAFEAPI StringCchPrintfA(
[out] STRSAFE_LPSTR pszDest,
[in] size_t cchDest,
[in] STRSAFE_LPCSTR pszFormat,
...
);
Parameter
[out] pszDest
Jenis: LPTSTR
Buffer tujuan, yang menerima string yang diformat dan dihentikan null yang dibuat dari pszFormat dan argumennya.
[in] cchDest
Jenis: size_t
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
Jenis: LPCTSTR
String format. String ini harus dihentikan null. Untuk informasi selengkapnya, lihat Format Sintaks Spesifikasi.
...
Argumen yang akan dimasukkan ke dalam string pszFormat .
Mengembalikan nilai
Jenis: HRESULT
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. |
Perhatikan bahwa fungsi ini mengembalikan nilai HRESULT , tidak seperti fungsi yang digantikan.
Keterangan
Dibandingkan dengan fungsi yang digantikannya, StringCchPrintf menyediakan pemrosesan tambahan untuk penanganan buffer yang tepat dalam kode Anda. Penanganan buffer yang buruk diimplikasikan dalam banyak masalah keamanan yang melibatkan buffer overruns. StringCchPrintf selalu null-mengakhiri buffer tujuan dengan panjang bukan nol.
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 StringCchPrintfEx jika Anda memerlukan penanganan nilai penunjuk string null.
StringCchPrintf dapat digunakan dalam bentuk generiknya, atau dalam bentuk yang lebih spesifik. Jenis data string menentukan bentuk fungsi ini yang harus Anda gunakan.
Jenis Data String | String Literal | Fungsi |
---|---|---|
char | "string" | StringCchPrintfA |
TCHAR | TEXT("string") | StringCchPrintf |
WCHAR | L"string" | StringCchPrintfW |
Contoh
Contoh berikut menunjukkan penggunaan sederhana StringCchPrintf, menggunakan empat argumen.
TCHAR pszDest[30];
size_t cchDest = 30;
LPCTSTR pszFormat = TEXT("%s %d + %d = %d.");
TCHAR* pszTxt = TEXT("The answer is");
HRESULT hr = StringCchPrintf(pszDest, cchDest, pszFormat, pszTxt, 1, 2, 3);
// The resultant string at pszDest is "The answer is 1 + 2 = 3."
Catatan
Header strsafe.h mendefinisikan StringCchPrintf 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 XP dengan SP2 [aplikasi desktop | Aplikasi UWP] |
Server minimum yang didukung | Windows Server 2003 dengan SP1 [aplikasi desktop | Aplikasi UWP] |
Target Platform | Windows |
Header | strsafe.h |
Lihat juga
Referensi
Saran dan Komentar
https://aka.ms/ContentUserFeedback.
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat:Kirim dan lihat umpan balik untuk