Fungsi StringCchCatA (strsafe.h)

  • Artikel

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 untuk fungsi berikut:

Sintaks

STRSAFEAPI StringCchCatA(
  [in, out] STRSAFE_LPSTR  pszDest,
  [in]      size_t         cchDest,
  [in]      STRSAFE_LPCSTR pszSrc
);

Parameter

[in, out] pszDest

Jenis: LPTSTR

Buffer tujuan, yang berisi string tempat 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 plus 1 untuk mempertanggungjawabkan 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 makro BERHASIL dan GAGAL untuk menguji nilai pengembalian fungsi ini.

Menampilkan kode Deskripsi
S_OK
 Data sumber ada, string sepenuhnya digabungkan tanpa pemotokan, 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 mencukuum. Buffer tujuan berisi versi hasil yang dihentikan dengan null dan dihentikan dari hasil yang dimaksud. 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

StringCchCat menyediakan pemrosesan tambahan untuk penanganan buffer yang tepat dalam kode Anda. Penanganan buffer yang buruk diimplikasikan dalam banyak masalah keamanan yang melibatkan overrun 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 tumpang tindih pszSrc dan pszDest .

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

StringCchCat 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" StringCchCatA
TCHAR TEXT("string") StringCchCat
WCHAR L"string" StringCchCatW
 

Catatan

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

StringCbCat

StringCchCatEx

StringCchCatn