Fungsi StringCchGetsA (strsafe.h)

Artikel
03/15/2023

Mendapatkan satu baris teks dari stdin, hingga dan termasuk karakter baris baru ('\n'). Baris teks disalin ke buffer tujuan, dan karakter baris baru diganti dengan karakter null. Ukuran buffer tujuan disediakan untuk fungsi untuk memastikan bahwa buffer tidak menulis melewati akhir buffer ini.

Catatan Fungsi ini hanya dapat digunakan sebaris.

StringCchGets adalah pengganti untuk fungsi berikut:

gets, _getws, _getts

StringCchGets bukan pengganti fget, yang tidak mengganti karakter baris baru dengan karakter null yang mengakhiri.

Sintaks

STRSAFEAPI StringCchGetsA(
  [out] STRSAFE_LPSTR pszDest,
  [in]  size_t        cchDest
);

Parameter

[out] pszDest

Jenis: LPTSTR

Buffer tujuan, yang menerima karakter yang disalin.

[in] cchDest

Jenis: size_t

Ukuran buffer tujuan, dalam karakter. Nilai ini harus minimal 2 agar fungsi berhasil. Jumlah maksimum karakter yang diizinkan, termasuk karakter null yang mengakhiri, adalah STRSAFE_MAX_CCH. Jika cchDest terlalu kecil untuk menahan baris lengkap teks, data akan dipotong.

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	Karakter dibaca dari stdin, disalin ke buffer di pszDest, dan buffer dihentikan null.
STRSAFE_E_END_OF_FILE	Menunjukkan kesalahan atau kondisi akhir file. Gunakan feof atau ferror untuk menentukan mana yang telah terjadi.
STRSAFE_E_INVALID_PARAMETER	Nilai dalam cchDest lebih besar dari nilai maksimum yang diizinkan.
STRSAFE_E_INSUFFICIENT_BUFFER	Nilai dalam cchDest adalah 1 atau kurang.

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

Keterangan

StringCchGets menyediakan pemrosesan tambahan untuk penanganan buffer yang tepat dalam kode Anda. Penanganan buffer yang buruk diimplikasikan dalam banyak masalah keamanan yang melibatkan overrun buffer. StringCchGets selalu null-mengakhiri buffer tujuan panjang bukan nol.

Nilai pszDest tidak boleh NULL. Lihat StringCchGetsEx jika Anda memerlukan penanganan nilai penunjuk string null.

StringCchGets 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"	StringCchGetsA
TCHAR	TEXT("string")	StringCchGets
WCHAR	L"string"	StringCchGetsW

Catatan

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

StringCbGets

StringCchGetsEx