Fungsi StringCchPrintfExA (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.
StringCchPrintfEx menambahkan ke fungsionalitas StringCchPrintf dengan mengembalikan penunjuk ke akhir string tujuan serta jumlah karakter yang dibiarkan tidak digunakan dalam string tersebut. Bendera juga dapat diteruskan ke fungsi untuk kontrol tambahan.
StringCchPrintfEx adalah pengganti untuk fungsi berikut:
Sintaks
STRSAFEAPI StringCchPrintfExA(
[out] STRSAFE_LPSTR pszDest,
[in] size_t cchDest,
[out, optional] STRSAFE_LPSTR *ppszDestEnd,
[out, optional] size_t *pcchRemaining,
[in] DWORD dwFlags,
[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.
[out, optional] ppszDestEnd
Jenis: LPTSTR*
Alamat penunjuk ke akhir pszDest. Jika ppszDestEnd bukan NULL dan data apa pun disalin ke buffer tujuan, ini menunjuk ke karakter null yang mengakhiri di akhir string.
[out, optional] pcchRemaining
Jenis: size_t*
Jumlah karakter yang tidak digunakan dalam pszDest, termasuk karakter null yang mengakhiri. Jika pcchRemainingadalah NULL, hitungan tidak disimpan atau dikembalikan.
[in] dwFlags
Jenis: DWORD
Satu atau beberapa nilai berikut ini.
[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 .
Nilai kembali
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 pemotokan dan buffer dihentikan null. |
|
Nilai dalam cchDest adalah 0 atau lebih besar dari STRSAFE_MAX_CCH, atau buffer tujuan sudah penuh. |
|
Operasi penyalinan gagal karena ruang buffer tidak mencukupi. Tergantung pada nilai dwFlags, buffer tujuan mungkin berisi versi hasil yang dihentikan null dan terpoting dari hasil yang dimaksudkan. Dalam situasi di mana pemotokan dapat diterima, ini mungkin belum tentu dipandang sebagai kondisi kegagalan. |
Perhatikan bahwa fungsi ini mengembalikan nilai HRESULT , tidak seperti fungsi yang digantikannya.
Keterangan
Dibandingkan dengan fungsi yang digantikannya, StringCchPrintfEx menyediakan pemrosesan tambahan untuk penanganan buffer yang tepat dalam kode Anda. Penanganan buffer yang buruk diimplikasikan dalam banyak masalah keamanan yang melibatkan overrun buffer. StringCchPrintfEx 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 kecuali bendera STRSAFE_IGNORE_NULLS ditentukan, dalam hal ini keduanya mungkin NULL. Namun, kesalahan karena ruang yang tidak mencukup mungkin masih dikembalikan meskipun nilai NULL diabaikan.
StringCchPrintfEx 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" | StringCchPrintfExA |
TCHAR | TEXT("string") | StringCchPrintfEx |
WCHAR | L"string" | StringCchPrintfExW |
Catatan
Header strsafe.h mendefinisikan StringCchPrintfEx 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 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