Fungsi StringCchVPrintfExA (strsafe.h)

  • Artikel

Menulis data yang diformat ke string yang ditentukan menggunakan penunjuk ke daftar argumen. Ukuran buffer tujuan disediakan untuk fungsi untuk memastikan bahwa buffer tidak menulis melewati akhir buffer ini.

StringCchVPrintfEx menambahkan ke fungsionalitas StringCchVPrintf 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.

StringCchVPrintfEx adalah pengganti untuk fungsi berikut:

Sintaks

STRSAFEAPI StringCchVPrintfExA(
  [out]           STRSAFE_LPSTR  pszDest,
  [in]            size_t         cchDest,
  [out, optional] STRSAFE_LPSTR  *ppszDestEnd,
  [out, optional] size_t         *pcchRemaining,
  [in]            DWORD          dwFlags,
  [in]            STRSAFE_LPCSTR pszFormat,
  [in]            va_list        argList
);

Parameter

[out] pszDest

Jenis: LPTSTR

Buffer tujuan, yang menerima string yang diformat dan dihentikan null yang dibuat dari pszFormat dan argList.

[in] cchDest

Jenis: size_t

Ukuran buffer tujuan, dalam karakter. Nilai ini harus cukup besar untuk mengakomodasi string berformat akhir ditambah 1 untuk memperhitungkan karakter null yang mengakhiri. Jumlah maksimum karakter yang diizinkan adalah STRSAFE_MAX_CCH.

[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("")).
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.

[in] pszFormat

Jenis: LPCTSTR

String format. String ini harus dihentikan null. Untuk informasi selengkapnya, lihat Format Sintaks Spesifikasi.

[in] argList

Jenis: va_list

Argumen yang akan dimasukkan ke dalam string pszFormat .

Nilai kembali

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
 Ada cukup ruang untuk hasil yang akan disalin ke pszDest tanpa pemotongan dan buffer dihentikan null.
STRSAFE_E_INVALID_PARAMETER
 Nilai dalam cchDest adalah 0 atau lebih besar dari STRSAFE_MAX_CCH, atau buffer tujuan sudah penuh.
STRSAFE_E_INSUFFICIENT_BUFFER
 Operasi penyalinan gagal karena ruang buffer yang tidak mencukupi. Tergantung pada nilai dwFlags, buffer tujuan mungkin 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

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

Untuk informasi selengkapnya tentang va_lists, lihat konvensi yang ditentukan dalam Stdarg.h.

Perilaku tidak terdefinisi jika string yang diarahkan oleh pszDest, pszFormat, atau string argumen apa pun tumpang tindih.

Baik pszFormat maupun pszDest tidak boleh NULL kecuali bendera STRSAFE_IGNORE_NULLS ditentukan, dalam hal ini keduanya mungkin NULL. Namun, kesalahan karena ruang yang tidak mencukup mungkin masih dikembalikan meskipun nilai NULL diabaikan.

StringCchVPrintfEx 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" StringCchVPrintfExA
TCHAR TEXT("string") StringCchVPrintfEx
WCHAR L"string" StringCchVPrintfExW
 

Catatan

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

StringCbVPrintfEx

StringCchPrintfEx

StringCchVPrintf