Fungsi RtlStringCchVPrintfExW (ntstrsafe.h)

Fungsi RtlStringCchVPrintfExW dan RtlStringCchVPrintfExA membuat string teks yang dihitung karakter, dengan pemformatan yang didasarkan pada informasi pemformatan yang disediakan.

Sintaks

NTSTRSAFEDDI RtlStringCchVPrintfExW(
  [out]           NTSTRSAFE_PWSTR  pszDest,
  [in]            size_t           cchDest,
  [out, optional] NTSTRSAFE_PWSTR  *ppszDestEnd,
  [out, optional] size_t           *pcchRemaining,
  [in]            DWORD            dwFlags,
  [in, optional]  NTSTRSAFE_PCWSTR pszFormat,
  [in]            va_list          argList
);

Parameter

[out] pszDest

Penunjuk ke buffer yang disediakan penelepon yang menerima string yang diformat dan dihentikan null. Fungsi ini membuat string ini dari string pemformatan yang disediakan oleh pszFormat dan argumen yang disediakan oleh argList. Pointer pszDest dapat berupa NULL, tetapi hanya jika STRSAFE_IGNORE_NULLS diatur dalam dwFlags.

[in] cchDest

Ukuran buffer tujuan, dalam karakter. Buffer harus cukup besar untuk berisi string yang diformat ditambah karakter null yang mengakhiri. Jumlah maksimum karakter yang diperbolehkan adalah NTSTRSAFE_MAX_CCH. Jika pszDestADALAH NULL, cchDest harus nol.

[out, optional] ppszDestEnd

Jika penelepon menyediakan penunjuk alamat non-NULL , setelah operasi selesai, fungsi memuat alamat tersebut dengan penunjuk ke terminator string null yang dihasilkan buffer tujuan.

[out, optional] pcchRemaining

Jika penelepon memasok penunjuk alamat non-NULL , fungsi memuat alamat dengan jumlah byte yang tidak digunakan yang ada di buffer yang diarahkan oleh pszDest, termasuk byte yang digunakan untuk karakter null yang mengakhiri.

[in] dwFlags

Satu atau beberapa bendera dan, secara opsional, byte isian. Bendera didefinisikan sebagai berikut.

Nilai	Makna
STRSAFE_FILL_BEHIND_NULL	Jika set dan fungsi berhasil, byte rendah dwFlags digunakan untuk mengisi bagian buffer tujuan yang mengikuti karakter null yang mengakhiri.
STRSAFE_IGNORE_NULLS	Jika diatur, pszDest bisa NULL. Pointer pszDestNULL tidak dapat menerima string yang tidak kosong.
STRSAFE_FILL_ON_FAILURE	Jika set dan fungsi gagal, byte rendah dwFlags digunakan untuk mengisi seluruh buffer tujuan, dan buffer dihentikan null. Operasi ini menimpa isi buffer yang sudah ada sebelumnya.
STRSAFE_NULL_ON_FAILURE	Jika diatur dan fungsi gagal, buffer tujuan diatur ke string kosong (TEXT("")). Operasi ini menimpa isi buffer yang sudah ada sebelumnya.
STRSAFE_NO_TRUNCATION	Jika diatur dan fungsi mengembalikan STATUS_BUFFER_OVERFLOW, konten buffer tujuan tidak dimodifikasi.

[in, optional] pszFormat

Penunjuk ke string teks yang dihentikan null yang berisi direktif pemformatan bergaya printf. Penunjuk pszFormat bisa NULL, tetapi hanya jika STRSAFE_IGNORE_NULLS diatur dalam dwFlags.

[in] argList

Daftar argumen va_list-ketik. Argumen yang terkandung dalam daftar argumen akan ditafsirkan dengan menggunakan string pemformatan yang disediakan oleh pszFormat.

Nilai kembali

Fungsi mengembalikan salah satu nilai NTSTATUS yang tercantum dalam tabel berikut. Untuk informasi tentang cara menguji nilai NTSTATUS, lihat Menggunakan Nilai NTSTATUS.

Menampilkan kode	Deskripsi
STATUS_SUCCESS	Status keberhasilan ini berarti data sumber ada, string output dibuat tanpa pemotongan, dan buffer tujuan yang dihasilkan dihentikan null.
STATUS_BUFFER_OVERFLOW	Status peringatan ini berarti operasi tidak selesai karena ruang yang tidak cukup di buffer tujuan. Jika STRSAFE_NO_TRUNCATION diatur dalam dwFlags, buffer tujuan tidak dimodifikasi. Jika bendera tidak diatur, buffer tujuan berisi versi terpotong dari string yang dibuat.
STATUS_INVALID_PARAMETER	Status kesalahan ini berarti fungsi menerima parameter input yang tidak valid. Untuk informasi selengkapnya, lihat paragraf berikut ini. Fungsi mengembalikan nilai STATUS_INVALID_PARAMETER saat: Bendera tidak valid ditentukan. Nilai dalam cchDest lebih besar dari ukuran buffer maksimum. Buffer tujuan sudah penuh. Penunjuk NULL ada tanpa bendera STRSAFE_IGNORE_NULLS. Penunjuk buffer tujuan null, tetapi ukuran buffer bukan nol. Penunjuk buffer tujuan adalah NULL, atau panjangnya nol, tetapi string sumber panjang bukan nol ada.

Keterangan

RtlStringCchVPrintfExW dan RtlStringCchVPrintfExA harus digunakan alih-alih fungsi berikut:

• vsprintf
• vswprintf
• _vsnprintf
• _vsnwprintf

Semua fungsi ini menerima string format dan argumennya, disediakan sebagai daftar argumen yang ditik va_list, dan mengembalikan string yang diformat. RtlStringCchVPrintfExW dan RtlStringCchVPrintfExA menerima ukuran, dalam karakter, dari buffer tujuan untuk memastikan bahwa mereka tidak menulis melewati akhir buffer.

RtlStringCchVPrintfExW dan RtlStringCchVPrintfExA menambah fungsionalitas RtlStringCchVPrintf dengan mengembalikan penunjuk ke akhir string tujuan, serta jumlah karakter yang tidak digunakan dalam string tersebut. Bendera dapat diteruskan ke fungsi untuk kontrol tambahan.

Untuk informasi selengkapnya tentang daftar argumen va_list-typed, lihat dokumentasi Microsoft Windows SDK.

Gunakan RtlStringCchVPrintfExW untuk menangani string Unicode dan RtlStringCchVPrintfExA untuk menangani string ANSI. Formulir yang Anda gunakan bergantung pada data Anda.

Jenis data string	String harfiah	Fungsi
WCHAR	L"string"	RtlStringCchVPrintfExW
char	"string"	RtlStringCchVPrintfExA

 

Jika pszDest dan pszFormat menunjuk ke string yang tumpang tindih atau jika ada string argumen yang tumpang tindih, perilaku fungsi tidak terdefinisi.

pszDest tidak boleh NULL kecuali bendera STRSAFE_IGNORE_NULLS diatur.

Untuk informasi selengkapnya tentang fungsi string aman, lihat Menggunakan Fungsi String Aman.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Tersedia di Windows XP dengan Paket Layanan 1 (SP1) dan versi Windows yang lebih baru.
Target Platform	Desktop
Header	ntstrsafe.h (termasuk Ntstrsafe.h)
Pustaka	Ntstrsafe.lib
IRQL	Bagaimanapun, jika string yang dimanipulasi selalu berada dalam memori, jika tidak, PASSIVE_LEVEL

Lihat juga

RtlStringCbVPrintfEx

RtlStringCchPrintfEx

RtlStringCchVPrintf