Fungsi StringCbCatExA (strsafe.h)

Artikel
11/20/2024

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

StringCbCatEx menambahkan fungsionalitas StringCbCat dengan mengembalikan penunjuk ke akhir string tujuan serta jumlah byte yang dibiarkan tidak digunakan dalam string tersebut. Bendera juga dapat diteruskan ke fungsi untuk kontrol tambahan.

StringCbCatEx adalah pengganti untuk fungsi berikut:

strcat, wcscat, _tcsat
lstrcat
StrCat
StrCatBuff

Sintaksis

STRSAFEAPI StringCbCatExA(
  [in, out]       STRSAFE_LPSTR  pszDest,
  [in]            size_t         cbDest,
  [in]            STRSAFE_LPCSTR pszSrc,
  [out, optional] STRSAFE_LPSTR  *ppszDestEnd,
  [out, optional] size_t         *pcbRemaining,
  [in]            DWORD          dwFlags
);

Parameter

[in, out] pszDest

Jenis: LPTSTR

String yang pszSrc akan digabungkan, dan yang 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 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] pcbRemaining

Jenis: size_t*

Jumlah byte yang tidak digunakan dalam pszDest, termasuk yang digunakan untuk karakter null yang mengakhiri. Jika pcbRemaining NULL, jumlah tidak disimpan atau dikembalikan.

[in] dwFlags

Jenis: DWORD

Satu atau beberapa nilai berikut.

Nilai	Arti
STRSAFE_FILL_BEHIND_NULL 0x00000200	Jika fungsi berhasil, byte rendah dwFlags (0) digunakan untuk mengisi bagian yang tidak diinisialisasi dari pszDest mengikuti karakter null yang mengakhiri.
STRSAFE_IGNORE_NULLS 0x00000100	Perlakukan penunjuk string NULL seperti string kosong (TEXT("")). Bendera ini berguna untuk meniru fungsi seperti lstrcpy.
STRSAFE_FILL_ON_FAILURE 0x00000400	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.
STRSAFE_NULL_ON_FAILURE 0x00000800	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.
STRSAFE_NO_TRUNCATION 0x00001000	Jika fungsi gagal, pszDest tidak tersentuh. Tidak ada yang ditambahkan ke konten asli.

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 cbDest kurang dari atau lebih besar dari nilai maksimum yang diizinkan.
STRSAFE_E_INSUFFICIENT_BUFFER	Operasi penyalinan gagal karena ruang buffer 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 dilihat sebagai kondisi kegagalan.

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

Komentar

StringCbCatEx menyediakan pemrosesan tambahan untuk penanganan buffer yang tepat dalam kode Anda. Penanganan buffer yang buruk diimplikasi dalam banyak masalah keamanan yang melibatkan overruns buffer. StringCbCatEx 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 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.

StringCbCatEx dapat digunakan dalam bentuk generiknya, atau dalam bentuk 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"	StringCbCatExA
TCHAR	TEXT("string")	StringCbCatEx
WCHAR	L"string"	StringCbCatExW

Nota

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

StringCbCatNEx

StringCchCatEx

Bagikan melalui