Fungsi StringCchCopyNA (strsafe.h)

  • Artikel

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

StringCchCopyN adalah pengganti untuk fungsi berikut:

Sintaks

STRSAFEAPI StringCchCopyNA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cchDest,
  [in]  STRSAFE_PCNZCH pszSrc,
  [in]  size_t         cchToCopy
);

Parameter

[out] pszDest

Jenis: LPTSTR

Buffer tujuan, yang menerima karakter yang disalin.

[in] cchDest

Jenis: size_t

Ukuran pszDest, dalam karakter. Nilai ini harus cukup besar untuk menahan karakter yang disalin (panjang pszSrc atau nilai cchSrc, mana pun yang lebih kecil) ditambah 1 untuk mempertangungjawabkan karakter null yang mengakhiri. Jumlah maksimum karakter yang diizinkan adalah STRSAFE_MAX_CCH.

[in] pszSrc

Jenis: LPCTSTR

String sumber. String ini harus dapat dibaca hingga karakter cchSrc atau terminator null, mana yang lebih dulu.

[in] cchToCopy

Jenis: size_t

Jumlah maksimum karakter yang akan disalin dari pszSrc ke pszDest.

Menampilkan 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, karakter disalin dari pszSrc tanpa pemotongan, 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 penyalinan gagal karena ruang buffer yang tidak mencukupi. Buffer tujuan berisi versi hasil yang dipotong dan dihentikan null. Dalam situasi di mana pemotongan dapat diterima, ini mungkin belum tentu dianggap sebagai kondisi kegagalan.
 

Perhatikan bahwa fungsi ini mengembalikan nilai HRESULT , tidak seperti fungsi yang digantikan.

Keterangan

StringCchCopyN menyediakan pemrosesan tambahan untuk penanganan buffer yang tepat dalam kode Anda. Penanganan buffer yang buruk diimplikasikan dalam banyak masalah keamanan yang melibatkan buffer overruns. StringCchCopyN 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 cchSrc lebih besar dari jumlah karakter dalam pszSrc, StringCchCopyN—tidak seperti strncpy—tidak terus melakukan pad pszDest dengan karakter null hingga karakter cchSrc telah disalin.

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

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

StringCchCopyN 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" StringCchCopyNA
TCHAR TEXT("string") StringCchCopyN
WCHAR L"string" StringCchCopyNW
 

Catatan

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

StringCbCopyN

StringCchCopy

StringCchCopyNEx