fungsi StringCchVPrintf_lW (strsafe.h)

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.

StringCchVPrintf_l mirip dengan StringCchVPrintf tetapi menyertakan parameter untuk informasi lokal.

Sintaksis

STRSAFEAPI StringCchVPrintf_lW(
  [out] STRSAFE_LPWSTR                                  pszDest,
  [in]  size_t                                          cchDest,
  [in]  _Printf_format_string_params_(2)STRSAFE_LPCWSTR pszFormat,
  [in]  _locale_t                                       locale,
  [in]  va_list                                         argList
);

Parameter

[out] pszDest

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

[in] cchDest

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.

[in] pszFormat

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

[in] locale

Objek lokal. Untuk informasi selengkapnya, lihat _create_locale.

[in] argList

Argumen yang akan dimasukkan ke dalam string pszFormat.

Mengembalikan nilai

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
 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.
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.

Komentar

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 yang tumpang tindih.

Baik pszFormat maupun pszDest harus NULL. Lihat StringCchVPrintf_lEx jika Anda memerlukan penanganan nilai penunjuk string null.

Untuk menggunakan fungsi ini, Anda harus menentukan makro berikut dalam file header Anda, sebelum menyertakan StrSafe.h.

#define STRSAFE_LOCALE_FUNCTIONS

Nota

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

Syarat Nilai
klien minimum yang didukung Windows Vista [aplikasi desktop | Aplikasi UWP]
server minimum yang didukung Windows Server 2008 [aplikasi desktop | Aplikasi UWP]
Platform Target Windows
Header strsafe.h
  • Last updated on