Fungsi StringCbCopyNA (strsafe.h)

Artikel
08/26/2023

Menyalin jumlah byte yang ditentukan dari satu string ke string lainnya. Ukuran buffer tujuan disediakan untuk fungsi untuk memastikan bahwa buffer tidak menulis melewati akhir buffer ini.

StringCbCopyN adalah pengganti untuk fungsi berikut:

strncpy, wcsncpy, _tcsncpy

Sintaks

STRSAFEAPI StringCbCopyNA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cbDest,
  [in]  STRSAFE_PCNZCH pszSrc,
  [in]  size_t         cbToCopy
);

Parameter

[out] pszDest

Jenis: LPTSTR

Buffer tujuan, yang menerima karakter yang disalin.

[in] cbDest

Jenis: size_t

Ukuran pszDest, dalam byte. Nilai ini harus cukup besar untuk menahan byte yang disalin (ukuran pszSrc atau nilai cbSrc, mana pun yang lebih kecil) dan juga mempertangungjawabkan karakter null yang mengakhiri. Jumlah maksimum karakter yang diizinkan adalah STRSAFE_MAX_CCH * sizeof(TCHAR).

[in] pszSrc

Jenis: LPCTSTR

String sumber. String ini harus dihentikan null.

[in] cbToCopy

Jenis: size_t

Jumlah maksimum byte yang akan disalin dari pszSrc 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, data disalin dari pszSrc tanpa pemotokan, dan buffer tujuan yang dihasilkan dihentikan null.
STRSAFE_E_INVALID_PARAMETER	Nilai dalam cbDest lebih besar dari `STRSAFE_MAX_CCH * sizeof(TCHAR)`, atau buffer tujuan sudah penuh.
STRSAFE_E_INSUFFICIENT_BUFFER	Operasi penyalinan gagal karena ruang buffer tidak mencukupi. 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

StringCbCopyN menyediakan pemrosesan tambahan untuk penanganan buffer yang tepat dalam kode Anda. Penanganan buffer yang buruk diimplikasikan dalam banyak masalah keamanan yang melibatkan overrun buffer. StringCbCopyN selalu null-terminates dan tidak pernah meluapkan buffer tujuan yang valid, bahkan jika konten string sumber berubah selama operasi.

Meskipun rutinitas ini dimaksudkan sebagai pengganti strncpy, ada perbedaan perilaku. Jika cbSrc lebih besar dari jumlah byte dalam pszSrc, StringCbCopyN—tidak seperti strncpy—tidak terus melakukan pad pszDest dengan karakter null hingga byte cbSrc telah disalin.

Perilaku tidak terdefinisi jika string yang diarahkan oleh tumpang tindih pszSrc dan pszDest .

Baik pszSrc maupun pszDest tidak boleh NULL. Lihat StringCbCopyNEx jika Anda memerlukan penanganan nilai penunjuk string null.

StringCbCopyN dapat digunakan dalam bentuk generiknya, atau dalam bentuk yang lebih spesifik. Jenis data string menentukan bentuk fungsi ini yang harus Anda gunakan, seperti yang diperlihatkan dalam tabel berikut.

Jenis Data String	String Literal	Fungsi
char	"string"	StringCbCopyNA
TCHAR	TEXT("string")	StringCbCopyN
WCHAR	L"string"	StringCbCopyNW

Catatan

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

StringCbCopy

StringCbCopyNEx

StringCchCopyN

Bagikan melalui