Fungsi RtlStringCbCatA (ntstrsafe.h)

Artikel
08/07/2023

Fungsi RtlStringCbCatW dan RtlStringCbCatA menggabungkan dua string yang dihitung byte.

Sintaks

NTSTRSAFEDDI RtlStringCbCatA(
  [in, out] NTSTRSAFE_PSTR  pszDest,
  [in]      size_t          cbDest,
  [in]      NTSTRSAFE_PCSTR pszSrc
);

Parameter

[in, out] pszDest

Penunjuk ke buffer yang, pada input, berisi string yang dihentikan null di mana pszSrc akan digabungkan. Pada output, ini adalah buffer tujuan yang berisi seluruh string yang dihasilkan. String di pszSrc ditambahkan ke akhir string di pszDest dan dihentikan dengan karakter null.

[in] cbDest

Ukuran buffer tujuan, dalam byte. Buffer tujuan harus cukup besar untuk menyertakan string yang digabungkan dan karakter null yang mengakhiri.

Untuk string Unicode, jumlah maksimum byte adalah NTSTRSAFE_MAX_CCH * sizeof(WCHAR).

Untuk string ANSI, jumlah maksimum byte adalah NTSTRSAFE_MAX_CCH * sizeof(char).

[in] pszSrc

Penunjuk ke string yang dihentikan null. String ini akan digabungkan ke akhir string yang terkandung dalam buffer di pszDest.

Menampilkan nilai

Fungsi mengembalikan salah satu nilai NTSTATUS yang tercantum dalam tabel berikut. Untuk informasi tentang cara menguji nilai NTSTATUS, lihat Menggunakan Nilai NTSTATUS.

Menampilkan kode	Deskripsi
STATUS_SUCCESS	Status keberhasilan ini berarti data sumber ada, string digabungkan tanpa pemotongan, dan buffer tujuan yang dihasilkan dihentikan null.
STATUS_BUFFER_OVERFLOW	Status peringatan ini berarti operasi penggabungan tidak selesai karena ruang buffer yang tidak mencukup. Buffer tujuan berisi versi hasil yang dipotong dan dihentikan null.
STATUS_INVALID_PARAMETER	Status kesalahan ini berarti fungsi menerima parameter input yang tidak valid. Untuk informasi selengkapnya, lihat paragraf berikut ini. Nilai pengembalian STATUS_INVALID_PARAMETER berarti salah satu hal berikut ini terjadi: Nilai dalam cbDest lebih besar dari ukuran buffer maksimum. Buffer tujuan sudah penuh. Penunjuk NULL ada. Panjang buffer tujuan adalah nol, tetapi string sumber panjang bukan nol ada.

Menampilkan kode

Deskripsi

STATUS_SUCCESS

Status keberhasilan ini berarti data sumber ada, string digabungkan tanpa pemotongan, dan buffer tujuan yang dihasilkan dihentikan null.

STATUS_BUFFER_OVERFLOW

Status peringatan ini berarti operasi penggabungan tidak selesai karena ruang buffer yang tidak mencukup. Buffer tujuan berisi versi hasil yang dipotong dan dihentikan null.

STATUS_INVALID_PARAMETER

Status kesalahan ini berarti fungsi menerima parameter input yang tidak valid. Untuk informasi selengkapnya, lihat paragraf berikut ini.

Nilai pengembalian STATUS_INVALID_PARAMETER berarti salah satu hal berikut ini terjadi:

Nilai dalam cbDest lebih besar dari ukuran buffer maksimum.
Buffer tujuan sudah penuh.
Penunjuk NULL ada.
Panjang buffer tujuan adalah nol, tetapi string sumber panjang bukan nol ada.

Keterangan

RtlStringCbCatW dan RtlStringCbCatA harus digunakan alih-alih fungsi berikut:

strcat
wcscat

Karena RtlStringCbCatW dan RtlStringCbCatA menerima ukuran buffer tujuan sebagai input, mereka tidak akan menulis melewati akhir buffer.

Gunakan RtlStringCbCatW untuk menangani string Unicode dan RtlStringCbCatA untuk menangani string ANSI. Formulir yang akan digunakan ditentukan oleh data Anda seperti yang diperlihatkan dalam tabel berikut ini.

Jenis data string	String harfiah	Fungsi
WCHAR	L"string"	RtlStringCbCatW
char	"string"	RtlStringCbCatA

Jika pszSrc dan pszDest menunjuk ke string yang tumpang tindih, perilaku fungsi tidak terdefinisi.

Baik pszSrc maupun pszDest tidak boleh NULL. Jika Anda perlu menangani nilai penunjuk string NULL , gunakan RtlStringCbCatNEx.

Untuk informasi selengkapnya tentang fungsi string aman, lihat Menggunakan Fungsi String Aman.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Tersedia di Windows XP dengan Paket Layanan 1 (SP1) dan versi Windows yang lebih baru.
Target Platform	Desktop
Header	ntstrsafe.h (termasuk Ntstrsafe.h)
Pustaka	Ntstrsafe.lib
IRQL	Bagaimanapun, jika string yang dimanipulasi selalu berada dalam memori, jika tidak, PASSIVE_LEVEL

Lihat juga

RtlStringCbCatEx

RtlStringCbCatNEx

RtlStringCchCatEx

Bagikan melalui