RtlStringCbPrintfW 函式 (ntstrsafe.h)

  • 發行項

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

語法

NTSTRSAFEDDI RtlStringCbPrintfW(
  [out] NTSTRSAFE_PWSTR  pszDest,
  [in]  size_t           cbDest,
  [in]  NTSTRSAFE_PCWSTR pszFormat,
        ...              
);

參數

[out] pszDest

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

[in] cbDest

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

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

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

[in] pszFormat

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

...

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

傳回值

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

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

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

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

備註

應該使用 RtlStringCbPrintfW 和 RtlStringCbPrintfA ，而不是下列函式：

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

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

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

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

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

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

範例

下列範例示範使用四個自變數的基本 RtlStringCbPrintfW 用法。

int const arraysize = 30;
WCHAR pszDest[arraysize]; 
size_t cbDest = arraysize * sizeof(WCHAR);

LPCWSTR pszFormat = L"%s %d + %d = %d.";
WCHAR* pszTxt = L"The answer is";

NTSTATUS status = RtlStringCbPrintfW(pszDest, cbDest, pszFormat, pszTxt, 1, 2, 3);

結果字串為「答案為 1 + 2 = 3」。它包含在 pszDest 的緩衝區中。

規格需求

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

另請參閱

RtlStringCbPrintfEx

RtlStringCbVPrintf

RtlStringCchPrintf