RtlStringCbVPrintfExA 函式 (ntstrsafe.h)

  • 發行項

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

語法

NTSTRSAFEDDI RtlStringCbVPrintfExA(
  [out, optional] NTSTRSAFE_PSTR  pszDest,
  [in]            size_t          cbDest,
  [out, optional] NTSTRSAFE_PSTR  *ppszDestEnd,
  [out, optional] size_t          *pcbRemaining,
  [in]            DWORD           dwFlags,
  [in, optional]  NTSTRSAFE_PCSTR pszFormat,
  [in]            va_list         argList
);

參數

[out, optional] pszDest

呼叫端提供的緩衝區指標，接收格式化、以 Null 結束的字串。 函式會從 pszFormat 提供的格式化字串和 argList 所提供的自變數建立此字串。 pszDest 指標可以是 NULL，但只有在 dwFlags 中設定STRSAFE_IGNORE_NULLS時。

[in] cbDest

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

針對 Unicode 字串，最大位元元節數會NTSTRSAFE_MAX_CCH * sizeof (WCHAR) 。

若為 ANSI 字串，最大位元元節數會NTSTRSAFE_MAX_CCH * sizeof (char) 。

如果 pszDest 為 NULL，cbDest 必須是零。

[out, optional] ppszDestEnd

如果呼叫端提供非 NULL 位址指標，則在作業完成之後，函式會載入該位址，其中包含目的地緩衝區產生的 Null 字串終止符的指標。

[out, optional] pcbRemaining

如果呼叫端提供非 NULL 位址指標，函式會載入位址，其中包含 pszDest 所指向之緩衝區中未使用的位元組數目，包括用於終止 Null 字元的位元組。

[in] dwFlags

一或多個旗標，並選擇性地填滿位元組。 旗標的定義如下：

值 意義
STRSAFE_FILL_BEHIND_NULL
如果 set 和 函式成功， 則會使用 dwFlags 的低位元組來填滿結束 Null 字元後面的目的地緩衝區部分。
STRSAFE_IGNORE_NULLS
如果設定， pszDest 或 pszSrc 或兩者都可以是 NULL。 NULLpszSrc 指標會被視為空字串 (TEXT (“”) ) ，可以複製。 NULLpszDest 指標無法接收無空字串。
STRSAFE_FILL_ON_FAILURE
如果 set 和 函式失敗， 則會使用 dwFlags 的低位元組來填滿整個目的地緩衝區，而緩衝區會以 Null 結束。 此作業會覆寫任何預先存在的緩衝區內容。
STRSAFE_NULL_ON_FAILURE
如果 set 和 函式失敗，目的地緩衝區會設定為空字串串， (TEXT (“”) ) 。 此作業會覆寫任何預先存在的緩衝區內容。
STRSAFE_NO_TRUNCATION
如果 set 和 函式傳回STATUS_BUFFER_OVERFLOW，則不會修改目的地緩衝區的內容。

[in, optional] pszFormat

包含 printf 樣式格式指示詞之 Null 終止文字字串的指標。 pszFormat 指標可以是 NULL，但只有在 dwFlags 中設定STRSAFE_IGNORE_NULLS時。

[in] argList

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

傳回值

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

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

當下列情況時，函式會傳回STATUS_INVALID_PARAMETER值：

  • 指定了無效的旗標。
  • cbDest 中的值大於緩衝區大小上限。
  • 目的地緩衝區已滿。
  • NULL 指標沒有STRSAFE_IGNORE_NULLS旗標。
  • 目的地緩衝區指標為 NULL，但緩衝區大小不是零。
  • 目的地緩衝區指標為 NULL，或其長度為零，但存在非零長度的來源字串。

備註

應該使用 RtlStringCbVPrintfExW 和 RtlStringCbVPrintfExA ，而不是下列函式：

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

RtlStringCbVPrintfExW 和 RtlStringCbVPrintfExA 會藉由傳回目的地字串結尾的指標，以及該字元串中未使用的位元組數目，新增至 RtlStringCbVPrintf 的功能。 旗標可以傳遞至 函式以取得其他控制件。

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

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

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

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

除非設定STRSAFE_IGNORE_NULLS旗標，否則 pszFormat 或 pszDest 都不能是 NULL ，在此情況下，或兩者都可以是 NULL。 如果 pszDest 為 NULL，pszFormat 必須是 NULL 或指向空字串。

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

規格需求

需求 值
最低支援的用戶端 在 Windows XP 中使用 Service Pack 1 (SP1) 和更新版本的 Windows。
目標平台 桌面
標頭 ntstrsafe.h (包含 Ntstrsafe.h)
程式庫 Ntstrsafe.lib
IRQL PASSIVE_LEVEL

另請參閱

RtlStringCbPrintfEx

RtlStringCbVPrintf

RtlStringCchVPrintfEx