共用方式為

RtlUnicodeStringPrintfEx 函式 （ntstrsafe.h）

  • 發行項

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

自選。 如果呼叫端為 UNICODE_STRING 結構提供非NULL 指標， 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

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

...

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

傳回值

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

傳回碼 描述
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 以取得其他控制件。

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

pszFormat 和 DestinationString 指標無法 NULL，除非在 dwFlags 中設定STRSAFE_IGNORE_NULLS旗標。 如果已設定STRSAFE_IGNORE_NULLS，則這兩個指標都可以 NULL。 如果 DestinationString 指標 NULL，pszFormat 指標必須 NULL 或指向空字符串。

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

要求

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

另請參閱

RtlUnicodeStringPrintf

RtlUnicodeStringVPrintf

RtlUnicodeStringVPrintfEx

UNICODE_STRING