Fungsi StringCchGetsExA (strsafe.h)

Artikel
03/04/2024

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.

StringCchGetsEx menambahkan ke fungsionalitas StringCchGets dengan mengembalikan penunjuk ke akhir string tujuan serta jumlah karakter yang tidak digunakan dalam string tersebut. Bendera juga dapat diteruskan ke fungsi untuk kontrol tambahan.

StringCchGetsEx adalah pengganti untuk fungsi berikut:

gets, _getws, _getts

StringCchGetsEx bukan pengganti untuk fgets, yang tidak mengganti karakter baris baru dengan karakter null yang mengakhiri.

Sintaks

STRSAFEAPI StringCchGetsExA(
  [out]           STRSAFE_LPSTR pszDest,
  [in]            size_t        cchDest,
  [out, optional] STRSAFE_LPSTR *ppszDestEnd,
  [out, optional] size_t        *pcchRemaining,
  [in]            DWORD         dwFlags
);

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, STRSAFE_MAX_CCH. Jika cchDest terlalu kecil untuk menahan baris lengkap teks, data akan dipotong.

[out, optional] ppszDestEnd

Jenis: LPTSTR*

Alamat pointer ke akhir pszDest. Jika ppszDestEnd bukan NULL dan data apa pun disalin ke buffer tujuan, ini menunjuk ke karakter null yang mengakhiri di akhir string.

[out, optional] pcchRemaining

Jenis: size_t*

Jumlah karakter yang tidak digunakan dalam pszDest, termasuk karakter null yang mengakhiri. Jika pcchRemainingNULL, jumlahnya tidak disimpan atau dikembalikan.

[in] dwFlags

Jenis: DWORD

Satu atau beberapa nilai berikut ini.

Nilai	Makna
STRSAFE_FILL_BEHIND_NULL 0x00000200	Jika fungsi berhasil, byte rendah dwFlags (0) digunakan untuk mengisi bagian pszDest yang tidak diinisialisasi mengikuti karakter null yang mengakhiri.
STRSAFE_IGNORE_NULLS 0x00000100	Perlakukan penunjuk string NULL seperti string kosong (TEXT("")). Bendera ini berguna untuk meniru fungsi seperti lstrcpy.
STRSAFE_FILL_ON_FAILURE 0x00000400	Jika fungsi gagal, byte rendah dwFlags (0) digunakan untuk mengisi seluruh buffer pszDest , dan buffer dihentikan null. Dalam kasus kegagalan STRSAFE_E_INSUFFICIENT_BUFFER , string terpotong apa pun yang dikembalikan ditimpa.
STRSAFE_NULL_ON_FAILURE 0x00000800	Jika fungsi gagal, pszDest diatur ke string kosong (TEXT("")). Dalam kasus kegagalan STRSAFE_E_INSUFFICIENT_BUFFER , string yang terpotong ditimpa.
STRSAFE_NO_TRUNCATION 0x00001000	Seperti dalam kasus STRSAFE_NULL_ON_FAILURE, jika fungsi gagal, pszDest diatur ke string kosong (TEXT("")). Dalam kasus kegagalan STRSAFE_E_INSUFFICIENT_BUFFER , string yang terpotong ditimpa.

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	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 atau bendera yang tidak valid diteruskan.
STRSAFE_E_INSUFFICIENT_BUFFER	Nilai dalam cchDest adalah 1 atau kurang.

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

Keterangan

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

Nilai pszDest tidak boleh NULL kecuali bendera STRSAFE_IGNORE_NULLS ditentukan. Namun, kesalahan karena ruang yang tidak mencukup mungkin masih dikembalikan meskipun nilai NULL diabaikan.

StringCchGetsEx 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"	StringCchGetsExA
TCHAR	TEXT("string")	StringCchGetsEx
WCHAR	L"string"	StringCchGetsExW

Catatan

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

StringCbGetsEx

StringCchGets

Bagikan melalui