共用方式為

RtlStringCbPrintfExA 函式 （ntstrsafe.h）

  • 發行項

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

語法

NTSTRSAFEDDI RtlStringCbPrintfExA(
  [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,
                  ...             
);

參數

[out, optional] pszDest

呼叫端提供的緩衝區指標，接收格式化、以 Null 結束的字串。 函式會從 pszFormat 和函式自變數清單所提供的格式字串建立此字串。 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

以 null 結束的文字字串指標，其中包含 printf樣式 格式指示詞。 pszFormat 指標可以 NULL，但只有在 dwFlags中設定STRSAFE_IGNORE_NULLS時。

...

函式所解譯的自變數清單，根據 pszFormat 字串中所包含的 格式指示詞。

傳回值

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

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

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

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

言論

RtlStringCbPrintfExW 和 RtlStringCbPrintfExA，而不是下列函式：

  • sprintf
  • swprintf
  • _snprintf
  • _snwprintf
所有這些函式都接受格式字串和自變數清單、解譯它們，以及建立格式化字串。 目的地緩衝區的大小，以位元組為單位，會提供給 RtlStringCbPrintfExW 和 RtlStringCbPrintfExA，以確保它們不會寫入緩衝區結尾。

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

使用 RtlStringCbPrintfExW 來處理 Unicode 字串，以及 RtlStringCbPrintfExA 來處理 ANSI 字串。 您使用的表單取決於您的資料，如下表所示。

字串數據類型 字串常值 功能
WCHAR L“string” RtlStringCbPrintfExW
char “string” RtlStringCbPrintfExA
 

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

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

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

要求

要求 價值
最低支援的用戶端 從 Windows XP 搭配 Service Pack 1 開始提供 （SP1）。
目標平臺 桌面
標頭 ntstrsafe.h （包括 Ntstrsafe.h）
連結庫 Ntstrsafe.lib
IRQL 如果所作的字串一律位於記憶體中，則為任何 ，否則PASSIVE_LEVEL

另請參閱

RtlStringCbVPrintfEx

RtlStringCchPrintf

RtlStringCchPrintfEx