RtlStringCchCopyUnicodeStringEx 函式 (ntstrsafe.h)
RtlStringCchCopyUnicodeStringEx 函式會將UNICODE_STRING結構的內容複製到指定的目的地。
語法
NTSTRSAFEDDI RtlStringCchCopyUnicodeStringEx(
[out] NTSTRSAFE_PWSTR pszDest,
[in] size_t cchDest,
[in] PCUNICODE_STRING SourceString,
[out] NTSTRSAFE_PWSTR *ppszDestEnd,
[out, optional] size_t *pcchRemaining,
[in] DWORD dwFlags
);
參數
[out] pszDest
選擇性。 接收所複製字串之緩衝區的指標。 SourceString 參數UNICODE_STRING結構指向的字串會複製到 pszDest 的緩衝區，並以 Null 字元終止。 此指標可以是 NULL，但只有在 dwFlags 中設定STRSAFE_IGNORE_NULLS時。
[in] cchDest
目的地緩衝區的大小，以字元為單位。 緩衝區必須夠大，字串和終止 Null 字元。 緩衝區中的字元數上限為 NTSTRSAFE_MAX_CCH。
[in] SourceString
選擇性。 包含要複製之字串 之UNICODE_STRING 結構的指標。 字串中的字元數上限為NTSTRSAFE_UNICODE_STRING_MAX_CCH。 此指標可以是 NULL，但只有在 dwFlags 中設定STRSAFE_IGNORE_NULLS時。
[out] ppszDestEnd
選擇性。 如果呼叫端提供非 NULL 位址指標，則在複製作業完成之後，函式會以目的地緩衝區產生的 Null 字串終止符指標載入該位址。
[out, optional] pcchRemaining
選擇性。 如果呼叫端提供非 NULL 位址指標，函式會載入位址，其中包含 pszDest 指向之緩衝區中未使用的字元數目，包括終止的 Null 字元。
[in] dwFlags
一或多個旗標，並選擇性地填滿位元組。 旗標的定義如下：
| 值 | 意義 |
|---|---|
| STRSAFE_FILL_BEHIND_NULL | 如果設定此旗標且函式成功， 則會使用 dwFlags 的低位元組來填滿結束 Null 字元後面的目的地緩衝區部分。 |
| STRSAFE_IGNORE_NULLS | 如果已設定此旗標，則來源或目的地指標或兩者都可以是 NULL。 RtlStringCchCopyUnicodeStringEx 會將 NULL 來源緩衝區指標視為空字串 (TEXT (“”) ) ，可以複製。 NULL 目的地緩衝區指標無法接收無空字串。 |
| STRSAFE_FILL_ON_FAILURE | 如果設定此旗標且函式失敗， 則會使用 dwFlags 的低位元組來填滿整個目的地緩衝區，而緩衝區會以 Null 結束。 此作業會覆寫任何預先存在的緩衝區內容。 |
| STRSAFE_NULL_ON_FAILURE | 如果設定此旗標且函式失敗，目的地緩衝區會設定為空字串， (TEXT (“”“) ) 。 此作業會覆寫任何預先存在的緩衝區內容。 |
| STRSAFE_NO_TRUNCATION |
如果已設定此旗標，且函式會傳回 STATUS_BUFFER_OVERFLOW：
|
傳回值
RtlStringCchCopyUnicodeStringEx 會傳回下列其中一個 NTSTATUS 值。
| 傳回碼 | Description |
|---|---|
| STATUS_SUCCESS | 此 成功 狀態表示源數據存在、字串複製而未截斷，且結果目的地緩衝區為 Null 終止。 |
| STATUS_BUFFER_OVERFLOW | 這個 警告 狀態表示複製作業因目的地緩衝區空間不足而未完成。 如果在 dwFlags 中設定STRSAFE_NO_TRUNCATION，則不會修改目的地緩衝區。 如果未設定旗標，目的地緩衝區會包含複製字串的截斷版本。 |
| STATUS_INVALID_PARAMETER | 這個 錯誤 狀態表示函式收到無效的輸入參數。 如需詳細資訊，請參閱下列清單。 |
當發生下列其中一項時，RtlStringCchCopyUnicodeStringEx 會傳回STATUS_INVALID_PARAMETER值：
- UNICODE_STRING 結構的內容無效。
- dwFlags 中指定了無效的旗標。
- cchDest 中的值大於緩衝區大小上限。
- 目的地緩衝區 (pszDest 指向) 已滿。
- 緩衝區指標為 NULL ，且未指定STRSAFE_IGNORE_NULLS旗標。
- 目的地緩衝區指標為 NULL，但緩衝區大小不是零。
- 目的地緩衝區指標為 NULL 或其長度為零，但存在非零長度來源字串。
如需如何測試 NTSTATUS 值的詳細資訊，請參閱 使用NTSTATUS值。
備註
RtlStringCchCopyUnicodeStringEx 函式會使用 cchDest 參數指定之) 目的地緩衝區的大小 (，以確保複製作業不會寫入緩衝區結尾。
RtlStringCchCopyUnicodeStringEx 藉由傳回目的地字串結尾的指標，以及該字串中未使用的位元組數目，新增至 RtlStringCchCopyUnicodeString 函式的功能。 您可以將旗標傳遞至 函式以取得其他控制件。
如果來源和目的地字串重疊，則函式的行為未定義。
除非在 dwFlags 中設定STRSAFE_IGNORE_NULLS旗標，否則 *SourceString *和 pszDest 指標不可為 NULL。 如果設定STRSAFE_IGNORE_NULLS，這兩個點可以是 NULL。 如果 pszDest 指標為 NULL，SourceString 指標必須是 NULL，或UNICODE_STRING結構必須描述空字串。
如需安全字串函式的詳細資訊，請參閱 使用安全字串函式。
規格需求
| 需求 | 值 |
|---|---|
| 最低支援的用戶端 | 在 Windows XP 中使用 Service Pack 1 (SP1) 和更新版本的 Windows。 |
| 目標平台 | 桌面 |
| 標頭 | ntstrsafe.h (包含 Ntstrsafe.h) |
| 程式庫 | Ntstrsafe.lib |
| IRQL | 如果正在操作的字串一律位於記憶體中，則為任何 ，否則PASSIVE_LEVEL |