Fungsi StringCchCatNA (strsafe.h)

Artikel
03/02/2024

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

StringCchCatN adalah pengganti untuk fungsi berikut:

Sintaks

STRSAFEAPI StringCchCatNA(
  [in, out] STRSAFE_LPSTR  pszDest,
  [in]      size_t         cchDest,
  [in]      STRSAFE_PCNZCH pszSrc,
  [in]      size_t         cchToAppend
);

Parameter

[in, out] pszDest

Jenis: LPTSTR

Buffer tujuan, yang berisi string yang akan digabungkan dengan pszSrc, dan akan menerima seluruh string yang dihasilkan. String di pszSrc, hingga karakter cchMaxAppend , ditambahkan ke akhir string di pszDest.

[in] cchDest

Jenis: size_t

Ukuran buffer tujuan, dalam karakter. Nilai ini harus sama dengan panjang pszSrc ditambah panjang pszDest atau cchMaxAppend (mana pun yang lebih kecil). Untuk jumlah ini tambahkan 1 ke akun untuk mengakhiri karakter null. Jumlah maksimum karakter yang diizinkan adalah STRSAFE_MAX_CCH.

[in] pszSrc

Jenis: LPCTSTR

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

[in] cchToAppend

Jenis: size_t

Jumlah maksimum karakter yang akan ditambahkan ke pszDest.

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 digabungkan tanpa pemotokan, dan buffer tujuan yang dihasilkan dihentikan null.
STRSAFE_E_INVALID_PARAMETER	Nilai dalam cchDest 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

Dibandingkan dengan fungsi yang digantikannya, StringCchCatN menyediakan pemrosesan tambahan untuk penanganan buffer yang tepat dalam kode Anda. Penanganan buffer yang buruk diimplikasikan dalam banyak masalah keamanan yang melibatkan overrun buffer. StringCchCatN 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 StringCchCatNEx jika Anda memerlukan penanganan nilai penunjuk string null.

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

Jenis Data String	String Literal	Fungsi
char	"string"	StringCchCatNA
TCHAR	TEXT("string")	StringCchCatn
WCHAR	L"string"	StringCchCatnW

Catatan

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

StringCbCatN

StringCchCat

StringCchCatnEx