RtlUnicodeStringPrintfEx 函式 (ntstrsafe.h)

發行項
02/26/2024

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

語法

NTSTRSAFEDDI RtlUnicodeStringPrintfEx(
  [out]           PUNICODE_STRING  DestinationString,
  [out, optional] PUNICODE_STRING  RemainingString,
  [in]            DWORD            dwFlags,
  [in]            NTSTRSAFE_PCWSTR pszFormat,
                  ...              
);

參數

[out] DestinationString

選擇性。接收格式化字串 之UNICODE_STRING 結構的指標。 RtlUnicodeStringPrintfEx 會從 pszFormat 指定的格式字串和函式的自變數清單建立此字串。字串中的字元數上限為NTSTRSAFE_UNICODE_STRING_MAX_CCH。 DestinationString 可以是 NULL，但只有在 dwFlags 中設定STRSAFE_IGNORE_NULLS時。

[out, optional] RemainingString

選擇性。如果呼叫端提供非 NULL 指標給 UNICODE_STRING 結構， RtlUnicodeStringPrintfEx 會將這個結構的 Buffer 成員設定為格式化字元串的結尾，將結構的 Length 成員設定為零，並將結構的 MaximumLength 成員設定為目的地緩衝區中剩餘的位元組數目。 RemainingString 可以是 NULL，但只有在 dwFlags 中設定STRSAFE_IGNORE_NULLS時。

[in] dwFlags

一或多個旗標，並選擇性地填滿位元組。旗標的定義如下：

STRSAFE_FILL_BEHIND

如果設定此旗標且函式成功， 則會使用 dwFlags 的低位元組來填滿字串中最後一個字元後面的目的地緩衝區部分。

STRSAFE_IGNORE_NULLS

如果已設定此旗標，則來源或目的地指標或兩者都可以是 NULL。 RtlUnicodeStringPrintfEx 會處理 NULL 來源緩衝區指標，例如空字串 (TEXT (“”) ) ，可以複製。 NULL 目的地緩衝區指標無法接收無空字串。

STRSAFE_FILL_ON_FAILURE

如果設定此旗標且函式失敗， 則會使用 dwFlags 的低位元組來填滿整個目的地緩衝區。此作業會覆寫任何預先存在的緩衝區內容。

STRSAFE_NULL_ON_FAILURE

如果設定此旗標且函式失敗，目的地緩衝區會設定為空字串， (TEXT (“”“) ) 。此作業會覆寫任何預先存在的緩衝區內容。

STRSAFE_NO_TRUNCATION

如果已設定此旗標，且函式會傳回STATUS_BUFFER_OVERFLOW，則不會修改目的地緩衝區的內容。

STRSAFE_ZERO_LENGTH_ON_FAILURE

如果已設定此旗標，且函式會傳回STATUS_BUFFER_OVERFLOW，則目的地字元串長度會設定為零個字節。

[in] pszFormat

包含 printf 樣式格式指示詞之 Null 終止文字字串的指標。此指標可以是 NULL，但只有在 dwFlags 中設定STRSAFE_IGNORE_NULLS時。

...

選擇性。 RtlUnicodeStringPrintfEx 解譯的自變數清單，根據 pszFormat 字串所指定的格式指示詞。

傳回值

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

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

當發生下列其中一項時，RtlUnicodeStringPrintfEx 會傳回STATUS_INVALID_PARAMETER值：

UNICODE_STRING 結構的內容無效。
dwFlags 中指定了無效的旗標。
目的地緩衝區已滿。
緩衝區指標為 NULL ，且 未在 dwFlags 中指定STRSAFE_IGNORE_NULLS旗標。
目的地緩衝區指標為 NULL，但緩衝區大小不是零。
目的地緩衝區指標為 NULL，或其長度為零，但存在非零長度的來源字串。

如需如何測試 NTSTATUS 值的詳細資訊，請參閱使用NTSTATUS值。

備註

RtlUnicodeStringPrintfEx 函式會使用目的地緩衝區的大小，以確保字串格式設定作業不會寫入超過緩衝區結尾。根據預設，函式不會以 null 字元值終止結果字串， (也就是零) 。或者，呼叫端可以使用STRSAFE_FILL_BEHIND旗標和填滿位元組值為零的填滿位元組值，以 null 結束不會佔用整個目的地緩衝區的結果字串。

RtlUnicodeStringPrintfEx 會傳回可識別目的地字串結尾的UNICODE_STRING結構，以及該字串中保留未使用的位元組數目，以新增至 RtlUnicodeStringPrintf 函式的功能。您可以將旗標傳遞至 RtlUnicodeStringPrintfEx 以取得其他控制件。

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

除非在 dwFlags 中設定STRSAFE_IGNORE_NULLS旗標，否則 pszFormat 和 DestinationString 指標不可為 NULL。如果已設定STRSAFE_IGNORE_NULLS，這兩個指標的其中一或兩個可以是 NULL。如果 DestinationString 指標為 NULL，pszFormat 指標必須是 NULL 或指向空字串。

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

規格需求

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