RtlStringCbVPrintfW 函式 (ntstrsafe.h)

  • 發行項

RtlStringCbVPrintfW 和 RtlStringCbVPrintfA 函式會建立位元組計數的文字字串，並以提供的格式資訊為基礎。

語法

NTSTRSAFEDDI RtlStringCbVPrintfW(
  [out] NTSTRSAFE_PWSTR  pszDest,
  [in]  size_t           cbDest,
  [in]  NTSTRSAFE_PCWSTR pszFormat,
  [in]  va_list          argList
);

參數

[out] pszDest

呼叫端提供的緩衝區指標，可接收格式化、以 Null 結束的字串。 函式會從 pszFormat 提供的格式化字串和 argList 所提供的自變數建立此字串。

[in] cbDest

目的地緩衝區的大小，以位元組為單位。 緩衝區必須夠大，才能包含格式化字串加上終止的 Null 字元。

若為 Unicode 字串，最大位元節數目為 NTSTRSAFE_MAX_CCH * sizeof (WCHAR) 。

對於 ANSI 字串，最大位元組數目是NTSTRSAFE_MAX_CCH * sizeof (char) 。

[in] pszFormat

包含 printf 樣式 格式指示詞之 Null 終止文字字串的指標。

[in] argList

va_list類型的自變數清單。 自變數清單中所包含的自變數將會使用 pszFormat 所提供的格式字串來解譯。

傳回值

函式會傳回下表所列的其中一個NTSTATUS值。 如需如何測試 NTSTATUS 值的資訊，請參閱 使用 NTSTATUS 值。

傳回碼 Description
STATUS_SUCCESS
 此 成功 狀態表示源數據已存在、已建立輸出字串而不截斷，且結果目的地緩衝區為 Null 終止。
STATUS_BUFFER_OVERFLOW
 這個 警告 狀態表示作業因目的地緩衝區空間不足而未完成。 目的地緩衝區包含已建立字串的截斷版本。
STATUS_INVALID_PARAMETER
 此錯誤狀態表示函式收到無效的輸入參數。 如需詳細資訊，請參閱下列段落。

函式會在下列情況下傳回STATUS_INVALID_PARAMETER值：

  • cbDest 中的值大於緩衝區大小上限。
  • 目的地緩衝區已滿。
  • NULL 指標存在。
  • 目的地緩衝區長度為零，但存在非零長度來源字串。

備註

應該使用 RtlStringCbVPrintfW 和 RtlStringCbVPrintfA ，而不是下列函式：

  • vsprintf
  • vswprintf
  • _vsnprintf
  • _vsnwprintf
所有這些函式都接受格式字串，以及 va_list型別自變數清單中的一組自變數，並傳回格式化字串。 目的地緩衝區的大小，以位元組為單位會提供給 RtlStringCbVPrintfW 和 RtlStringCbVPrintfA ，以確保它們不會寫入緩衝區結尾。

如需va_list型別自變數清單的詳細資訊，請參閱 Microsoft Windows SDK 檔。

使用 RtlStringCbVPrintfW 來處理 Unicode 字串和 RtlStringCbVPrintfA 來處理 ANSI 字串。 您使用的表單取決於您的資料，如下表所示。

字串資料類型 字串常值 函式
WCHAR L“string” RtlStringCbVPrintfW
char "字串" RtlStringCbVPrintfA
 

如果 pszDest 和 pszFormat 指向重疊字串，或有任何自變數字串重疊，則函式的行為是未定義的。

pszFormat 或 pszDest 都不應該是 NULL。 如果您需要處理 NULL 字串指標值，請使用 RtlStringCbVPrintfEx。

如需安全字串函式的詳細資訊，請參閱 使用安全字串函式。

規格需求

需求 值
最低支援的用戶端 從 Windows XP service Pack 1 (SP1) 開始提供。
目標平台 桌面
標頭 ntstrsafe.h (包含 Ntstrsafe.h)
程式庫 Ntstrsafe.lib
IRQL PASSIVE_LEVEL

另請參閱

RtlStringCbPrintf

RtlStringCbVPrintfEx

RtlStringCchVPrintf