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

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

傳回值

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

發生下列其中一項時，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結構必須描述空字串。

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

規格需求

另請參閱

• RtlUnicodeStringCopy
• UNICODE_STRING