Fungsi StringCchCopyA (strsafe.h)

Artikel
11/20/2024

Menyalin satu string ke string lainnya. Ukuran buffer tujuan disediakan untuk fungsi untuk memastikan bahwa buffer tidak menulis melewati akhir buffer ini.

StringCchCopy adalah pengganti fungsi berikut:

Sintaksis

STRSAFEAPI StringCchCopyA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cchDest,
  [in]  STRSAFE_LPCSTR pszSrc
);

Parameter

[out] pszDest

Jenis: LPTSTR

Buffer tujuan, yang menerima string yang disalin.

[in] cchDest

Jenis: size_t

Ukuran buffer tujuan, dalam karakter. Nilai ini harus sama dengan panjang pszSrc ditambah 1 untuk memperhitungkan string sumber yang disalin dan karakter null yang mengakhiri. Jumlah maksimum karakter yang diizinkan adalah STRSAFE_MAX_CCH.

[in] pszSrc

Jenis: LPCTSTR

String sumber. String ini harus dihentikan null.

Mengembalikan nilai

Jenis: HRESULT

Fungsi ini dapat mengembalikan salah satu nilai berikut. Sangat disarankan agar Anda menggunakan BERHASIL dan makro GAGAL untuk menguji nilai pengembalian fungsi ini.

Mengembalikan kode	Deskripsi
S_OK	Data sumber ada, disalin sepenuhnya tanpa pemotongan, dan buffer tujuan yang dihasilkan dihentikan null.
STRSAFE_E_INVALID_PARAMETER	Nilai dalam cchDest adalah 0 atau lebih besar dari STRSAFE_MAX_CCH.
STRSAFE_E_INSUFFICIENT_BUFFER	Operasi penyalinan gagal karena ruang buffer tidak mencukupi. Buffer tujuan berisi versi hasil yang dipotong dan dihentikan null yang dimaksudkan. Dalam situasi di mana pemotongan dapat diterima, ini mungkin belum tentu dilihat sebagai kondisi kegagalan.

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

Komentar

Dibandingkan dengan fungsi yang digantinya, StringCchCopy menyediakan pemrosesan tambahan untuk penanganan buffer yang tepat dalam kode Anda. Penanganan buffer yang buruk diimplikasi dalam banyak masalah keamanan yang melibatkan overruns buffer. StringCchCopy 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 pszSrc dan pszDest tumpang tindih.

Baik pszSrc maupun pszDest harus NULL. Lihat StringCchCopyEx jika Anda memerlukan penanganan nilai penunjuk string null.

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

Tipe Data String	String Literal	Fungsi
karakter	"string"	StringCchCopyA
TCHAR	TEXT("string")	StringCchCopy
WCHAR	L"string"	StringCchCopyW

Nota

Header strsafe.h mendefinisikan StringCchCopy sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta preprosedur 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

Syarat	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]
Platform Target	Windows
Header	strsafe.h

Lihat juga

Referensi

StringCbCopy

StringCchCopyEx

Bagikan melalui