共用方式為

RtlStringCchPrintfExW 函式 （ntstrsafe.h）

  • 發行項

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

語法

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,
                  ...              
);

參數

[out, optional] pszDest

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

[in] cchDest

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

[out, optional] ppszDestEnd

如果呼叫端提供非NULL 位址指標，則作業完成之後，函式會載入該位址，並具有目的地緩衝區結果 NULL 字串終止符的指標。

[out, optional] pcchRemaining

如果呼叫端提供非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] 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值：

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

言論

RtlStringCchPrintfExW 和 RtlStringCchPrintfExA，而不是下列函式：

  • sprintf
  • swprintf
  • _snprintf
  • _snwprintf
所有這些函式都接受格式字串和自變數清單，並傳回格式化字串。 RtlStringCchPrintfExW 和 RtlStringCchPrintfExA 接受目的地緩衝區的大小，以確保它們不會寫入超過這個緩衝區的結尾。

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

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

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

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

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

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

要求

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

另請參閱

RtlStringCbPrintfEx

RtlStringCchPrintf

RtlStringCchVPrintfEx