共用方式為

RtlUnicodeStringCopyEx 函式 (ntstrsafe.h)

  • 發行項

RtlUnicodeStringCopyEx 函式會將字串從一個UNICODE_STRING結構複製到另一個結構。

語法

NTSTRSAFEDDI RtlUnicodeStringCopyEx(
  [out]           PUNICODE_STRING  DestinationString,
  [in]            PCUNICODE_STRING SourceString,
  [out, optional] PUNICODE_STRING  RemainingString,
  [in]            DWORD            dwFlags
);

參數

[out] DestinationString

選擇性。 UNICODE_STRING 結構的指標。 來源字串會複製到目的地字串。 結構字串緩衝區中的位元組數目上限為 NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR)。 DestinationString 可以是 NULL，但只有在 dwFlags 中設定STRSAFE_IGNORE_NULLS時。

[in] SourceString

選擇性。 UNICODE_STRING 結構的指標。 這個結構包含包含來源字串的緩衝區。 此字串將會複製到目的地字串。 結構字串緩衝區中的位元組數目上限為 NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR)。 SourceString 可以是 NULL，但只有在 dwFlags 中設定STRSAFE_IGNORE_NULLS時。

[out, optional] RemainingString

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

[in] dwFlags

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

值 意義
STRSAFE_FILL_BEHIND 如果設定此旗標且函式成功， 則會使用 dwFlags 的低位元組來填滿字串中最後一個字元後面的目的地緩衝區部分。
STRSAFE_IGNORE_NULLS 如果已設定此旗標，則來源或目的地指標或兩者可以是 NULL。 RtlUnicodeStringCopyEx 會將 NULL 來源緩衝區指標視為空字串 (，例如可以複製的 TEXT (“”) ) 。 NULL 目的地緩衝區指標無法接收空字串。
STRSAFE_FILL_ON_FAILURE 如果設定此旗標且函式失敗， 則會使用 dwFlags 的低位元組來填滿整個目的地緩衝區。 此作業會覆寫任何既有的緩衝區內容。
STRSAFE_NULL_ON_FAILURE 如果設定此旗標且函式失敗，目的地緩衝區會設定為空字串， (TEXT (“”) ) 。 此作業會覆寫任何既有的緩衝區內容。
STRSAFE_NO_TRUNCATION

如果已設定此旗標，且函式會 傳回STATUS_BUFFER_OVERFLOW：

  • 如果同時指定STRSAFE_FILL_ON_FAILURE，STRSAFE_NO_TRUNCATION據以填入目的地緩衝區。
  • 否則，即使未設定 STRSAFE_NULL_ON_FAILURE ，目的地緩衝區的內容也會設定為空字串。 忽略STRSAFE_FILL_BEHIND_NULL。
STRSAFE_ZERO_LENGTH_ON_FAILURE 如果已設定此旗標，且函式會傳回STATUS_BUFFER_OVERFLOW，則目的字元串長度會設定為零個字節。

傳回值

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

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

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

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

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

備註

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

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

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

除非在 dwFlags 中設定了STRSAFE_IGNORE_NULLS旗標，否則 SourceString 和 DestinationString 指標不可為 NULL。 如果已設定STRSAFE_IGNORE_NULLS，這兩個指標可以是 NULL。 如果 DestinationString 指標為 NULL，SourceString 指標必須是 NULL，或UNICODE_STRING結構必須描述空字串。

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

規格需求

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

另請參閱