RtlStringCbCopyUnicodeString 函式 (ntstrsafe.h)
RtlStringCbCopyUnicodeString 函式會將UNICODE_STRING結構的內容複製到指定的目的地。
語法
NTSTRSAFEDDI RtlStringCbCopyUnicodeString(
[out] NTSTRSAFE_PWSTR pszDest,
[in] size_t cbDest,
[in] PCUNICODE_STRING SourceString
);
參數
[out] pszDest
接收複製字串之緩衝區的指標。 SourceString 參數UNICODE_STRING結構指向的字串會複製到 pszDest 的緩衝區,並以 Null 字元終止。
[in] cbDest
pszDest 所指向目的地緩衝區的大小,以位元組為單位。 緩衝區必須夠大,才能包含字串和終止的 Null 字元。 緩衝區中的位元元組數目上限為 NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof (WCHAR) 。
[in] SourceString
包含要複製之字串 的UNICODE_STRING 結構的指標。 字串中的位元組數目上限為 NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof (WCHAR) 。
傳回值
RtlStringCbCopyUnicodeString 會傳回下列其中一個 NTSTATUS 值。
傳回碼 | Description |
---|---|
|
此 成功 狀態表示源數據存在、字串已複製而不截斷,且結果目的地緩衝區會以 Null 結束。 |
|
這個 警告 狀態表示複製作業因緩衝區空間不足而未完成。 目的地緩衝區包含已截斷且以 Null 終止之預期結果的版本。 |
|
此錯誤狀態表示函式收到無效的輸入參數。 如需詳細資訊,請參閱下列清單。 |
發生下列其中一項時,RtlStringCbCopyUnicodeString 會傳回STATUS_INVALID_PARAMETER值:
- UNICODE_STRING結構的內容無效。
- cbDest 中的值大於緩衝區大小上限。
- 目的地緩衝區 (pszDest 指向) 已滿。
- 緩衝區指標為 NULL。
- 目的地緩衝區的長度為零,但存在非零長度來源字串。
備註
RtlStringCbCopyUnicodeString 函式會使用目的地緩衝區的大小 (cbDest 參數指定) ,以確保複製作業不會寫入緩衝區結尾。
如果來源和目的地字串重疊,則函式的行為是未定義的。
SourceString 和 pszDest 指標不可為 NULL。 如果您需要處理 NULL 指標值,請使用 RtlStringCbCopyUnicodeStringEx 函 式。
如需安全字串函式的詳細資訊,請參閱 使用安全字串函式。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | 從 Windows XP service Pack 1 (SP1) 開始提供。 |
目標平台 | 桌面 |
標頭 | ntstrsafe.h (包含 Ntstrsafe.h) |
程式庫 | Ntstrsafe.lib |
IRQL | 如果正在操作的字串一律位於記憶體中,則為任何 ,否則PASSIVE_LEVEL |