Fungsi StringCbCatA (strsafe.h)

Artikel
03/15/2023

Menggabungkan satu string ke string lain. Ukuran buffer tujuan disediakan untuk fungsi untuk memastikan bahwa buffer tidak menulis melewati akhir buffer ini.

StringCbCat adalah pengganti untuk fungsi berikut:

Sintaks

STRSAFEAPI StringCbCatA(
  [in, out] STRSAFE_LPSTR  pszDest,
  [in]      size_t         cbDest,
  [in]      STRSAFE_LPCSTR pszSrc
);

Parameter

[in, out] pszDest

Jenis: LPTSTR

String tempat pszSrc akan digabungkan, dan itu akan menerima seluruh string yang dihasilkan. String di pszSrc ditambahkan ke akhir string di pszDest.

[in] cbDest

Jenis: size_t

Ukuran buffer tujuan, dalam byte. Nilai ini harus mempertimbangkan panjang pszSrc ditambah panjang pszDest ditambah karakter null yang mengakhiri. Jumlah maksimum byte yang diizinkan adalah STRSAFE_MAX_CCH * sizeof(TCHAR).

[in] pszSrc

Jenis: LPCTSTR

String sumber yang akan digabungkan ke akhir pszDest. String ini harus dihentikan null.

Menampilkan 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
S_OK	Data sumber ada, string sepenuhnya digabungkan tanpa pemotongan, dan buffer tujuan yang dihasilkan dihentikan null.
STRSAFE_E_INVALID_PARAMETER	Nilai dalam cbDest kurang dari `sizeof(TCHAR)` atau lebih besar dari nilai maksimum yang diizinkan.
STRSAFE_E_INSUFFICIENT_BUFFER	Operasi penggabungan gagal karena ruang buffer yang tidak mencukup. 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

StringCbCat menyediakan pemrosesan tambahan untuk penanganan buffer yang tepat dalam kode Anda. Penanganan buffer yang buruk diimplikasikan dalam banyak masalah keamanan yang melibatkan buffer overruns. Ini selalu null-terminates dan tidak pernah meluap buffer tujuan yang valid, bahkan jika konten string sumber berubah selama operasi.

StringCbCat 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"	StringCbCatA
TCHAR	TEXT("string")	StringCbCat
WCHAR	L"string"	StringCbCatW

Perilaku tidak terdefinisi jika string diarahkan oleh tumpang tindih pszSrc dan pszDest .

Baik pszSrc maupun pszDest tidak boleh NULL. Lihat StringCbCatEx jika Anda memerlukan penanganan nilai penunjuk string null.

Catatan

Header strsafe.h mendefinisikan StringCbCat 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

StringCbCatEx

StringCbCatN

StringCchCat

Bagikan melalui