RtlStringCchCopyExW 函式 （ntstrsafe.h）

RtlStringCchCopyExW 和 RtlStringCchCopyExA 函式會將字元計數位符串複製到緩衝區。

語法

NTSTRSAFEDDI RtlStringCchCopyExW(
  [out, optional] NTSTRSAFE_PWSTR  pszDest,
  [in]            size_t           cchDest,
  [in, optional]  NTSTRSAFE_PCWSTR pszSrc,
  [out, optional] NTSTRSAFE_PWSTR  *ppszDestEnd,
  [out, optional] size_t           *pcchRemaining,
  [in]            DWORD            dwFlags
);

參數

[out, optional] pszDest

接收複製字串之呼叫端提供的緩衝區指標。 pszSrc 的字串會複製到 pszDest 的緩衝區，並以 null 字元終止。 pszDest 指標可以 NULL，但只有在 dwFlags中設定STRSAFE_IGNORE_NULLS時。

[in] cchDest

目的地緩衝區的大小，以字元為單位。 允許的字元數上限為 NTSTRSAFE_MAX_CCH。 如果 pszDest 為 NULL，cchDest 必須是零。

[in, optional] pszSrc

呼叫端提供的 Null 終止字串指標。 pszSrc 指標可以 NULL，但只有在 dwFlags中設定STRSAFE_IGNORE_NULLS時。

[out, optional] ppszDestEnd

如果呼叫端提供非NULL 位址指標，則在複製作業完成之後，函式會載入該位址，並具有目的地緩衝區所產生 Null 字串終止符的指標。

[out, optional] pcchRemaining

如果呼叫端提供非NULL 位址指標，函式會載入位址，其中包含 pszDest 所指向之緩衝區中未使用的字元數，包括終止的 null 字元。

[in] dwFlags

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

價值	意義
STRSAFE_FILL_BEHIND_NULL	如果設定此旗標且函式成功，則會使用 dwFlags 的低位元組來填滿結尾 Null 字元後面的目的地緩衝區部分。
STRSAFE_IGNORE_NULLS	如果設定此旗標，pszDest 或 pszSrc或兩者都可以 NULL。 NULLpszSrc 指標會被視為可以複製的空字串（TEXT（“”）。 nullpszDest 指標無法接收空字串。
STRSAFE_FILL_ON_FAILURE	如果設定此旗標且函式失敗，則會使用 dwFlags 的低位元組來填滿整個目的地緩衝區，而緩衝區會以 null 結束。 此作業會覆寫任何預先存在的緩衝區內容。
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。

傳回值

此函式會傳回下表所列的其中一個NTSTATUS值。 如需如何測試 NTSTATUS 值的資訊，請參閱使用 NTSTATUS 值。

傳回碼	描述
STATUS_SUCCESS	此 成功 狀態表示源數據存在、字串在沒有截斷的情況下複製，而結果目的地緩衝區會以 null 結束。
STATUS_BUFFER_OVERFLOW	此 警告 狀態表示複製作業因目的地緩衝區空間不足而未完成。 如果在 dwFlags中設定 STRSAFE_NO_TRUNCATION，則不會修改目的地緩衝區。 如果未設定旗標，目的地緩衝區會包含已建立字串的截斷版本。
STATUS_INVALID_PARAMETER	這個 錯誤 狀態表示函式收到無效的輸入參數。 如需詳細資訊，請參閱下列段落。 函式會在下列情況下傳回STATUS_INVALID_PARAMETER值： 指定了無效的旗標。 cchDest 中的值大於緩衝區大小上限。 目的地緩衝區已滿。 NULL 指標沒有 STRSAFE_IGNORE_NULLS 旗標。 目的地緩衝區指標 NULL，但緩衝區大小不是零。 目的地緩衝區指標 NULL，或其長度為零，但存在非零長度的來源字串。

言論

RtlStringCchCopyExW 和 RtlStringCchCopyExA 應使用，而不是下列函式：

• strcpy
• wcscpy

目的地緩衝區的大小會以字元為單位提供給 RtlStringCchCopyExW，RtlStringCchCopyExA，以確保它們不會寫入緩衝區結尾。

RtlStringCchCopyExW 和 RtlStringCchCopyExA 將指標傳回至目的地字元串結尾的指標，以及該字元串中未使用的字元數，以新增至 RtlStringCchCopy 的功能。 旗標可以傳遞至 函式以取得其他控制件。 使用 RtlStringCchCopyExW 來處理 Unicode 字串和 RtlStringCchCopyExA 來處理 ANSI 字符串。 您使用的表單取決於您的資料，如下表所示。

字串數據類型	字串常值	功能
WCHAR	L“string”	RtlStringCchCopyExW
char	“string”	RtlStringCchCopyExA

如果 pszSrc 和 pszDest 指向重迭字串，則函式的行為是未定義的。

pszSrc 或 pszDest 都不能 NULL，除非設定STRSAFE_IGNORE_NULLS旗標，在此情況下或兩者都可以 NULL。 如果 pszDestNULL，pszSrc 必須 NULL 或指向空字串。

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

要求

要求	價值
最低支援的用戶端	Windows XP 中提供 Service Pack 1 （SP1） 和更新版本的 Windows。
目標平臺	桌面
標頭	ntstrsafe.h （包括 Ntstrsafe.h）
連結庫	Ntstrsafe.lib
IRQL	如果所操作的字串一律位於記憶體中，則為任何 ，否則PASSIVE_LEVEL

另請參閱

• RtlStringCbCopyEx
• RtlStringCchCopy