Fungsi StringCchCatExA (strsafe.h)
Menggabungkan satu string ke string lain. Ukuran buffer tujuan disediakan untuk fungsi untuk memastikan bahwa buffer tidak menulis melewati akhir buffer ini.
StringCchCatEx menambahkan ke fungsionalitas StringCchCat dengan mengembalikan penunjuk ke akhir string tujuan serta jumlah karakter yang tidak digunakan dalam string tersebut. Bendera juga dapat diteruskan ke fungsi untuk kontrol tambahan.
StringCchCatEx adalah pengganti untuk fungsi berikut:
Sintaks
STRSAFEAPI StringCchCatExA(
[in, out] STRSAFE_LPSTR pszDest,
[in] size_t cchDest,
[in] STRSAFE_LPCSTR pszSrc,
[out, optional] STRSAFE_LPSTR *ppszDestEnd,
[out, optional] size_t *pcchRemaining,
[in] DWORD dwFlags
);
Parameter
[in, out] pszDest
Jenis: LPTSTR
Buffer tujuan, yang berisi string yang akan digabungkan ke pszSrc, dan yang akan menerima seluruh string yang dihasilkan. String di pszSrc ditambahkan ke akhir string di pszDest.
[in] cchDest
Jenis: size_t
Ukuran buffer tujuan, dalam karakter. Nilai ini harus sama dengan panjang pszSrc ditambah panjang pszDest ditambah 1 untuk mempertangungkan string dan karakter null yang mengakhiri. Jumlah maksimum karakter yang diizinkan adalah STRSAFE_MAX_CCH.
[in] pszSrc
Jenis: LPCTSTR
String sumber yang akan digabungkan ke akhir pszDest. String ini harus dihentikan null.
[out, optional] ppszDestEnd
Jenis: LPTSTR*
Alamat pointer ke akhir pszDest. Jika ppszDestEnd bukan NULL dan data apa pun ditambahkan 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 pcchRemainingNULL, jumlahnya tidak disimpan atau dikembalikan.
[in] dwFlags
Jenis: DWORD
Satu atau beberapa nilai berikut ini.
Nilai | Makna |
---|---|
|
Jika fungsi berhasil, byte rendah dwFlags (0) digunakan untuk mengisi bagian pszDest yang tidak diinisialisasi mengikuti karakter null yang mengakhiri. |
|
Perlakukan penunjuk string NULL seperti string kosong (TEXT("")). Bendera ini berguna untuk meniru fungsi seperti lstrcpy. |
|
Jika fungsi gagal, byte rendah dwFlags (0) digunakan untuk mengisi seluruh buffer pszDest , dan buffer dihentikan null. Dalam kasus kegagalan STRSAFE_E_INSUFFICIENT_BUFFER , string yang sudah ada atau terpotong sebelumnya di buffer tujuan ditimpa. |
|
Jika fungsi gagal, pszDest diatur ke string kosong (TEXT("")). Dalam kasus kegagalan STRSAFE_E_INSUFFICIENT_BUFFER , string yang sudah ada atau terpotong sebelumnya di buffer tujuan ditimpa. |
|
Jika fungsi gagal, pszDest tidak tersentuh . Tidak ada yang ditambahkan ke konten asli. |
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 |
---|---|
|
Data sumber ada, string sepenuhnya digabungkan tanpa pemotongan, dan buffer tujuan yang dihasilkan 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 yang tidak mencukupi. Tergantung pada nilai dwFlags, buffer tujuan mungkin 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
StringCchCatEx menyediakan pemrosesan tambahan untuk penanganan buffer yang tepat dalam kode Anda. Penanganan buffer yang buruk diimplikasikan dalam banyak masalah keamanan yang melibatkan buffer overruns. StringCchCatEx selalu null-terminates dan tidak pernah meluapkan buffer tujuan yang valid, bahkan jika konten string sumber berubah selama operasi.
Perilaku tidak terdefinisi jika string diarahkan oleh tumpang tindih pszSrc dan pszDest .
Baik pszSrc 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.
StringCchCatEx dapat digunakan dalam bentuk generiknya, atau dalam bentuk yang lebih spesifik. Jenis data string menentukan bentuk fungsi ini yang harus Anda gunakan, seperti yang diperlihatkan dalam tabel berikut.
Jenis Data String | String Literal | Fungsi |
---|---|---|
char | "string" | StringCchCatExA |
TCHAR | TEXT("string") | StringCchCatEx |
WCHAR | L"string" | StringCchCatExW |
Catatan
Header strsafe.h mendefinisikan StringCchCatEx sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta preprossesor 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