Fungsi RtlStringCchPrintfExW (ntstrsafe.h)

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

Sintaks

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

Parameter

[out, optional] 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 daftar argumen fungsi. Pointer pszDest bisa 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 diizinkan adalah NTSTRSAFE_MAX_CCH. Jika pszDest adalah NULL, cchDest harus nol.

[out, optional] ppszDestEnd

Jika pemanggil 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 pemanggil menyediakan penunjuk alamat non-NULL , fungsi memuat alamat dengan jumlah karakter yang tidak digunakan dalam buffer yang ditujukkan oleh pszDest, termasuk 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 diatur dan fungsi berhasil, byte rendah dwFlags digunakan untuk mengisi bagian buffer tujuan yang mengikuti karakter null yang mengakhiri.
STRSAFE_IGNORE_NULLS	Jika diatur, pszDest atau pszSrc, atau keduanya, bisa NULL. Pointer pszSrcNULL diperlakukan seperti string kosong (TEXT("")), yang dapat disalin. Pointer pszDestNULL tidak dapat menerima string yang tidak kosong.
STRSAFE_FILL_ON_FAILURE	Jika diatur 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] pszFormat

Penunjuk ke string teks null-terminated yang berisi direktif pemformatan bergaya printf. Penunjuk pszFormat dapat berupa NULL, tetapi hanya jika STRSAFE_IGNORE_NULLS diatur dalam dwFlags.

...

Daftar opsional argumen yang ditafsirkan oleh fungsi, berdasarkan direktif pemformatan yang terkandung dalam string 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 pemotokan, 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 string yang dibuat yang terpotok.
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 yang 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 adalah NULL, tetapi ukuran buffer bukan nol. Penunjuk buffer tujuan adalah NULL, atau panjangnya nol, tetapi string sumber panjang bukan nol ada.

Keterangan

RtlStringCchPrintfExW dan RtlStringCchPrintfExA harus digunakan alih-alih fungsi berikut:

• Sprintf
• swprintf
• _snprintf
• _snwprintf

Semua fungsi ini menerima string format dan daftar argumen dan mengembalikan string yang diformat. RtlStringCchPrintfExW dan RtlStringCchPrintfExA menerima ukuran, dalam karakter, dari buffer tujuan untuk memastikan bahwa mereka tidak menulis melewati akhir buffer ini.

RtlStringCchPrintfExW dan RtlStringCchPrintfExA menambahkan ke fungsionalitas RtlStringCchPrintf dengan mengembalikan pointer ke akhir string tujuan, serta jumlah karakter yang tidak digunakan dalam string tersebut. Bendera dapat diteruskan ke fungsi untuk kontrol tambahan.

Gunakan RtlStringCchPrintfExW untuk menangani string Unicode dan RtlStringCchPrintfExA untuk menangani string ANSI. Formulir yang Anda gunakan bergantung pada data Anda, seperti yang diperlihatkan dalam tabel berikut ini.

Jenis data string	String literal	Fungsi
WCHAR	L"string"	RtlStringCchPrintfExW
char	"string"	RtlStringCchPrintfExA

 

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

Baik pszSrc maupun pszDest tidak dapat berupa NULL kecuali bendera STRSAFE_IGNORE_NULLS diatur, dalam hal ini baik atau keduanya dapat NULL. Jika pszDest adalah NULL, pszSrc harus NULL atau menunjuk ke string kosong.

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

RtlStringCbPrintfEx

RtlStringCchPrintf

RtlStringCchVPrintfEx