Fungsi StringCbCatNW (strsafe.h)

Artikel
11/20/2024

Menggabungkan jumlah byte yang ditentukan dari satu string ke string lain. Ukuran, dalam byte, dari buffer tujuan disediakan untuk fungsi untuk memastikan bahwa ia tidak menulis melewati akhir buffer ini.

StringCbCatN adalah pengganti fungsi berikut:

strncat
StrNCat

Sintaksis

STRSAFEAPI StringCbCatNW(
  [in, out] STRSAFE_LPWSTR  pszDest,
  [in]      size_t          cbDest,
  [in]      STRSAFE_PCNZWCH pszSrc,
  [in]      size_t          cbToAppend
);

Parameter

[in, out] pszDest

Jenis: LPTSTR

Buffer tujuan, yang berisi string yang akan digabungkan ke pszSrc, dan akan menerima string yang dihasilkan. String di pszSrc, hingga cbMaxAppend byte, 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 atau cbMaxAppend (mana yang lebih kecil) 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 sumber ini harus dihentikan null.

[in] cbToAppend

Jenis: size_t

Jumlah maksimum byte yang akan ditambahkan ke pszDest.

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 digabungkan tanpa pemotongan, dan buffer tujuan yang dihasilkan dihentikan null.
STRSAFE_E_INVALID_PARAMETER	Nilai dalam cbDest lebih besar dari nilai maksimum yang diizinkan, 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

Dibandingkan dengan fungsi yang digantinya, StringCbCatN menyediakan pemrosesan tambahan untuk penanganan buffer yang tepat dalam kode Anda. Penanganan buffer yang buruk diimplikasi dalam banyak masalah keamanan yang melibatkan overruns buffer. StringCbCatN 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 StringCbCatNEx jika Anda memerlukan penanganan nilai penunjuk string null.

StringCbCatN dapat digunakan dalam bentuk generiknya, atau dalam bentuk yang lebih spesifik. Jenis data string menentukan bentuk fungsi ini yang harus Anda gunakan.

Tipe Data String	String Literal	Fungsi
karakter	"string"	StringCbCatNA
TCHAR	TEXT("string")	StringCbCatN
WCHAR	L"string"	StringCbCatNW

Nota

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

StringCchCatn

Bagikan melalui