Fungsi StringCbGetsA (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.

StringCbGets adalah pengganti untuk fungsi berikut:

gets, _getws, _getts

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

Sintaks

STRSAFEAPI StringCbGetsA(
  [out] STRSAFE_LPSTR pszDest,
  [in]  size_t        cbDest
);

Parameter

[out] pszDest

Jenis: LPTSTR

Buffer tujuan, yang menerima input.

[in] cbDest

Jenis: size_t

Ukuran buffer tujuan, dalam byte. Nilai ini harus lebih besar dari sizeof(TCHAR) agar fungsi berhasil. Jumlah maksimum byte yang diizinkan adalah STRSAFE_MAX_CCH * sizeof(TCHAR). Jika cbDest 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	Data 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 cbDest lebih besar dari nilai maksimum yang diizinkan.
STRSAFE_E_INSUFFICIENT_BUFFER	Nilai dalam cbDest adalah `sizeof(TCHAR)` atau kurang.

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

Keterangan

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

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

StringCbGets 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"	StringCbGetsA
TCHAR	TEXT("string")	StringCbGets
WCHAR	L"string"	StringCbGetsW

Catatan

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

StringCbGetsEx

StringCchGets

Bagikan melalui