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
以 null 結束的文字字串指標,其中包含 printf樣式 格式指示詞。
...
函式根據 pszFormat 字串 中包含的格式指示詞解譯的自變數清單。
傳回值
此函式會傳回下表所列的其中一個NTSTATUS值。 如需如何測試 NTSTATUS 值的資訊,請參閱使用 NTSTATUS 值 。
傳回碼 | 描述 |
---|---|
|
此 成功 狀態表示源數據存在、建立字串而不截斷,且結果目的地緩衝區為 null 終止。 |
|
此 警告 狀態表示作業因目的地緩衝區空間不足而未完成。 目的地緩衝區包含輸出字串的截斷版本。 |
|
這個 錯誤 狀態表示函式收到無效的輸入參數。 如需詳細資訊,請參閱下列段落。
函式會在下列情況下傳回STATUS_INVALID_PARAMETER值:
|
言論
RtlStringCbPrintfW 和 RtlStringCbPrintfA 應使用,而不是下列函式:
- sprintf
- swprintf
- _snprintf
- _snwprintf
使用 RtlStringCbPrintfW 來處理 Unicode 字串,並 RtlStringCbPrintfA 來處理 ANSI 字符串。 您使用的表單取決於您的資料,如下表所示。
字串數據類型 | 字串常值 | 功能 |
---|---|---|
WCHAR | L“string” | RtlStringCbPrintfW |
char | “string” | 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 |