Fungsi StringCchCatNExA (strsafe.h)

Artikel
08/26/2023

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.

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

StringCchCatNEx adalah pengganti untuk fungsi berikut:

Sintaks

STRSAFEAPI StringCchCatNExA(
  [in, out]       STRSAFE_LPSTR  pszDest,
  [in]            size_t         cchDest,
  [in]            STRSAFE_PCNZCH pszSrc,
  [in]            size_t         cchToAppend,
  [out, optional] STRSAFE_LPSTR  *ppszDestEnd,
  [out, optional] size_t         *pcchRemaining,
  [in]            DWORD          dwFlags
);

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 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 plus 1 untuk mempertangungjawabkan karakter null yang mengakhiri. 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.

[out, optional] ppszDestEnd

Jenis: LPTSTR*

Alamat penunjuk 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] pcchRemaining

Jenis: size_t*

Jumlah karakter yang tidak digunakan dalam pszDest, termasuk karakter null yang mengakhiri. Jika pcchRemainingadalah NULL, hitungan tidak disimpan atau dikembalikan.

[in] dwFlags

Jenis: DWORD

Satu atau beberapa nilai berikut ini.

Nilai	Makna
STRSAFE_FILL_BEHIND_NULL 0x00000200	Jika fungsi berhasil, byte rendah dwFlags (0) digunakan untuk mengisi bagian pszDest yang tidak diinisialisasi mengikuti karakter null yang mengakhiri.
STRSAFE_IGNORE_NULLS 0x00000100	Perlakukan penunjuk string NULL seperti string kosong (TEXT("")).
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 , untai (karakter) yang sudah ada atau terpotok 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 , untai (karakter) yang sudah ada atau terpotok sebelumnya di buffer tujuan ditimpa.
STRSAFE_NO_TRUNCATION 0x00001000	Jika fungsi gagal, pszDest tidak tersentuh . Tidak ada yang ditambahkan ke konten asli.

Nilai kembali

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, bendera yang tidak valid diteruskan, atau ada perbedaan antara ukuran pszDest, cchDest, dan jumlah bahan untuk ditambahkan dalam pszSrc.
STRSAFE_E_INSUFFICIENT_BUFFER	Operasi penyalinan gagal karena ruang buffer tidak mencukupi. Tergantung pada nilai dwFlags, buffer tujuan mungkin berisi versi hasil yang dihentikan null dan terpoting dari hasil yang dimaksudkan. 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, StringCchCatNEx menyediakan pemrosesan tambahan untuk penanganan buffer yang tepat dalam kode Anda. Penanganan buffer yang buruk diimplikasikan dalam banyak masalah keamanan yang melibatkan overrun buffer. StringCchCatNEx selalu null-terminates dan tidak pernah meluap-luap 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 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.

StringCchCatNEx 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"	StringCchCatnExa
TCHAR	TEXT("string")	StringCchCatnEx
WCHAR	L"string"	StringCchCatnExw

Catatan

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


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

StringCbCatNEx

StringCchCatEx

StringCchCatn

Bagikan melalui