RtlUnicodeStringPrintf 函式 (ntstrsafe.h)

RtlUnicodeStringPrintf 函式會建立文字字串,其格式是以提供的格式化資訊為基礎,並將字串儲存在UNICODE_STRING結構中。

語法

NTSTRSAFEDDI RtlUnicodeStringPrintf(
  [out] PUNICODE_STRING  DestinationString,
  [in]  NTSTRSAFE_PCWSTR pszFormat,
        ...              
);

參數

[out] DestinationString

接收格式化字串 之UNICODE_STRING 結構的指標。 RtlUnicodeStringPrintf 會從 pszFormat 指定的格式字串和函式的自變數清單建立此字串。 字串中的字元數上限為NTSTRSAFE_UNICODE_STRING_MAX_CCH。

[in] pszFormat

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

...

選擇性。 函式根據 pszFormat 字串包含的格式指示詞來解譯的自變數清單。

傳回值

RtlUnicodeStringPrintf 會傳回下列其中一個 NTSTATUS 值。

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

當發生下列其中一項時,RtlUnicodeStringPrintf 會傳回STATUS_INVALID_PARAMETER值:

  • DestinationString 參數指向之UNICODE_STRING結構的內容無效。
  • 目的地緩衝區已滿。
  • NULL 指標存在。
  • 目的地緩衝區的長度為零,但存在非零長度的來源字串。
如需如何測試 NTSTATUS 值的詳細資訊,請參閱 使用NTSTATUS值

備註

RtlUnicodeStringPrintf 函式會使用目的地緩衝區的大小,以確保字串格式設定作業不會寫入緩衝區結尾。 函式不會以 Null 字元終止結果字串。

如果格式字串和目的地字串重疊,則函式的行為未定義。

pszFormatDestinationString 指標不可為 NULL。 如果您需要處理 NULL 指標值,請使用 RtlUnicodeStringPrintfEx 函 式。

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

規格需求

需求
最低支援的用戶端 在 Windows XP 中使用 Service Pack 1 (SP1) 和更新版本的 Windows。
目標平台 桌面
標頭 ntstrsafe.h (包含 Ntstrsafe.h)
程式庫 Ntstrsafe.lib
IRQL 如果正在操作的字串一律位於記憶體中,則為任何 ,否則PASSIVE_LEVEL

另請參閱

RtlUnicodeStringPrintfEx

RtlUnicodeStringVPrintf

RtlUnicodeStringVPrintfEx

UNICODE_STRING