RtlUnicodeStringCchCopyNEx 函式 (ntstrsafe.h)
RtlUnicodeStringCchCopyNEx 函式會將字元串從一個UNICODE_STRING結構複製到另一個結構，同時限制複製字元串的大小。
語法
NTSTRSAFEDDI RtlUnicodeStringCchCopyNEx(
[out] PUNICODE_STRING DestinationString,
[in] PCUNICODE_STRING SourceString,
[in] size_t cchToCopy,
[out, optional] PUNICODE_STRING RemainingString,
[in] DWORD dwFlags
);
參數
[out] DestinationString
選擇性。 接收所複製字串 之UNICODE_STRING 結構的指標。 SourceString 參數UNICODE_STRING結構所指向的字串會複製到 DestinationString 參數UNICODE_STRING結構所指向的緩衝區。 結構字串緩衝區中的字元數上限為NTSTRSAFE_UNICODE_STRING_MAX_CCH。 DestinationString 可以是 NULL，但只有在 dwFlags 中設定STRSAFE_IGNORE_NULLS時。
[in] SourceString
選擇性。 包含要複製之字串 之UNICODE_STRING 結構的指標。 結構字串緩衝區中的字元數上限為 NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR)。 SourceString 可以是 NULL，但只有在 dwFlags 中設定STRSAFE_IGNORE_NULLS時。
[in] cchToCopy
要從來源複製到目的地的字元數。
[out, optional] RemainingString
選擇性。 如果呼叫端提供非 NULL 指標給 UNICODE_STRING 結構，函式會將這個結構的 Buffer 成員設定為串連字串的結尾、將結構的 Length 成員設定為零，並將結構的 MaximumLength 成員設定為目的地緩衝區中剩餘的位元組數目。 RemainingString 可以是 NULL，但只有在 dwFlags 中設定STRSAFE_IGNORE_NULLS時。
[in] dwFlags
一或多個旗標，並選擇性地填滿位元組。 旗標的定義如下：
| 值 | 意義 |
|---|---|
| STRSAFE_FILL_BEHIND | 如果設定此旗標且函式成功， 則會使用 dwFlags 的低位元組來填滿字串中最後一個字元後面的目的地緩衝區部分。 |
| STRSAFE_IGNORE_NULLS | 如果已設定此旗標，則來源或目的地指標或兩者都可以是 NULL。 RtlUnicodeStringCchCopyNEx 會將 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，則目的地字元串長度會設定為零個字節。 |
傳回值
RtlUnicodeStringCchCopyNEx 會傳回下列其中一個 NTSTATUS 值。
| 傳回碼 | Description |
|---|---|
| STATUS_SUCCESS | 此 成功 狀態表示源數據存在，而且字串會串連而不截斷。 |
| STATUS_BUFFER_OVERFLOW | 這個 警告 狀態表示複製作業因目的地緩衝區空間不足而未完成。 如果在 dwFlags 中設定STRSAFE_NO_TRUNCATION，則不會修改目的地緩衝區。 如果未設定旗標，目的地緩衝區會包含複製字串的截斷版本。 |
| STATUS_INVALID_PARAMETER | 這個 錯誤 狀態表示函式收到無效的輸入參數。 如需詳細資訊，請參閱下列清單。 |
當發生下列其中一項時，RtlUnicodeStringCchCopyNEx 會傳回STATUS_INVALID_PARAMETER值：
- UNICODE_STRING 結構的內容無效。
- dwFlags 中指定了無效的旗標。
- 目的地緩衝區已滿。
- 緩衝區指標為 NULL ，且 未在 dwFlags 中指定STRSAFE_IGNORE_NULLS旗標。
- 目的地緩衝區指標為 NULL，但緩衝區大小不是零。
- 目的地緩衝區指標為 NULL，或其長度為零，但存在非零長度的來源字串。
- cchToCopy 參數的值大於 NTSTRSAFE_UNICODE_STRING_MAX_CCH。
如需如何測試 NTSTATUS 值的詳細資訊，請參閱 使用NTSTATUS值。
備註
RtlUnicodeStringCchCopyNEx 函式會使用目的地緩衝區的大小，以確保複製作業不會寫入緩衝區結尾。 根據預設，函式 不會 以 null 字元值終止結果字串， (也就是零) 。 或者，呼叫端可以使用STRSAFE_FILL_BEHIND旗標和填滿位元組值為零的填滿位元組值，以 null 結束不會佔用整個目的地緩衝區的結果字串。
RtlUnicodeStringCchCopyNEx 會傳回可識別目的地字串結尾的UNICODE_STRING結構，以及該字串中未使用的位元元數目，以新增至 RtlUnicodeStringCchCopyN 函式的功能。 您可以將旗標傳遞至 RtlUnicodeStringCchCopyNEx 以取得其他控制件。
如果來源和目的地字串重疊，則函式的行為未定義。
除非在 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 |