Fungsi StringCchCatW (strsafe.h)

Artikel
11/20/2024

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

StringCchCat adalah pengganti fungsi berikut:

strcat, wcscat, _tcsat
lstrcat
StrCat
StrCatBuff

Sintaksis

STRSAFEAPI StringCchCatW(
  [in, out] STRSAFE_LPWSTR  pszDest,
  [in]      size_t          cchDest,
  [in]      STRSAFE_LPCWSTR pszSrc
);

Parameter

[in, out] pszDest

Jenis: LPTSTR

Buffer tujuan, yang berisi string yang pszSrc akan digabungkan, 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 lebih besar dari atau sama dengan panjang pszSrc ditambah panjang pszDest ditambah 1 untuk memperhitungkan 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.

Mengembalikan nilai

Jenis: HRESULT

Fungsi ini dapat mengembalikan salah satu nilai berikut. Sangat disarankan agar Anda menggunakan BERHASIL dan makro GAGAL untuk menguji nilai pengembalian fungsi ini.

Mengembalikan 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 cchDest adalah 0 atau lebih besar dari STRSAFE_MAX_CCH, atau buffer tujuan sudah penuh.
STRSAFE_E_INSUFFICIENT_BUFFER	Operasi penggabungan gagal karena ruang buffer yang tidak mencukup. Buffer tujuan berisi versi hasil yang dipotong dan dihentikan null yang dimaksudkan. Dalam situasi di mana pemotongan dapat diterima, ini mungkin belum tentu dilihat sebagai kondisi kegagalan.

Perhatikan bahwa fungsi ini mengembalikan nilai HRESULT , tidak seperti fungsi yang digantikannya.

Komentar

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

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

Baik pszSrc maupun pszDest harus NULL. Lihat StringCchCatEx jika Anda memerlukan penanganan nilai penunjuk string null.

StringCchCat dapat digunakan dalam bentuk generiknya, atau dalam bentuknya yang lebih spesifik. Jenis data string menentukan bentuk fungsi ini yang harus Anda gunakan, seperti yang ditunjukkan dalam tabel berikut.

Tipe Data String	String Literal	Fungsi
karakter	"string"	StringCchCatA
TCHAR	TEXT("string")	StringCchCat
WCHAR	L"string"	StringCchCatW

Nota

Header strsafe.h mendefinisikan StringCchCat sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta preprosektor 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

Syarat	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]
Platform Target	Windows
Header	strsafe.h

Lihat juga

Referensi

StringCbCat

StringCchCatEx

StringCchCatn

Bagikan melalui