RtlStringCchVPrintfW 函式 (ntstrsafe.h)

  • 發行項

RtlStringCchVPrintfW 和 RtlStringCchVPrintfA 函式會建立字元計數的文字字串，其格式是以所提供的格式資訊為基礎。

語法

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

參數

[out] pszDest

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

[in] cchDest

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

[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值：

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

備註

應該使用 RtlStringCchVPrintfW 和 RtlStringCchVPrintfA，而不是下列函式：

  • vsprintf
  • vswprintf
  • _vsnprintf
  • _vsnwprintf
所有這些函式都接受格式字串及其自變數，這些自變數會以 va_list類型的自變數清單的形式提供，並傳回格式化字串。 RtlStringCchVPrintfW 和 RtlStringCchVPrintfA 接收目的地緩衝區的大小，以確保函式不會寫入超過緩衝區的結尾。

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

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

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

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

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

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

規格需求

需求 值
最低支援的用戶端 在 Windows XP 中使用 Service Pack 1 (SP1) 和更新版本的 Windows。
目標平台 桌面
標頭 ntstrsafe.h (包含 Ntstrsafe.h)
程式庫 Ntstrsafe.lib
IRQL 如果正在操作的字串一律位於記憶體中，則為任何 ，否則PASSIVE_LEVEL

另請參閱

RtlStringCbVPrintf

RtlStringCchPrintf

RtlStringCchVPrintfEx