RtlStringCbCopyW 函式 （ntstrsafe.h）

RtlStringCbCopyW 和 RtlStringCbCopyA 函式會將位元組計數位符串複製到緩衝區。

語法

NTSTRSAFEDDI RtlStringCbCopyW(
  [out] NTSTRSAFE_PWSTR  pszDest,
  [in]  size_t           cbDest,
  [in]  NTSTRSAFE_PCWSTR pszSrc
);

參數

[out] pszDest

接收複製字串之呼叫端提供的緩衝區指標。 pszSrc 的字串會複製到 pszDest 的緩衝區，並以 null 字元終止。

[in] cbDest

目的地緩衝區的大小，以位元組為單位。 緩衝區必須夠大，字串和終止的 Null 字元。

若為 Unicode 字串，最大位元節數會NTSTRSAFE_MAX_CCH * sizeof（WCHAR）。

針對 ANSI 字串，位元組數目上限為 NTSTRSAFE_MAX_CCH * sizeof（char）。

[in] pszSrc

呼叫端提供的 Null 終止字串指標。

傳回值

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

傳回碼 描述
STATUS_SUCCESS
 此 成功 狀態表示源數據存在、字串在沒有截斷的情況下複製，而結果目的地緩衝區會以 null 結束。
STATUS_BUFFER_OVERFLOW
 此 警告 狀態表示複製作業因緩衝區空間不足而未完成。 目的地緩衝區包含已截斷且以 Null 終止之預期結果的版本。
STATUS_INVALID_PARAMETER
 這個 錯誤 狀態表示函式收到無效的輸入參數。 如需詳細資訊，請參閱下列段落。

函式會在下列情況下傳回STATUS_INVALID_PARAMETER值：

  • cbDest 中的值大於緩衝區大小上限。
  • 目的地緩衝區已滿。
  • NULL 指標存在。
  • 目的地緩衝區的長度為零，但存在非零長度的來源字串。

言論

RtlStringCbCopyA 和 RtlStringCbCopyW 應使用，而不是下列函式：

  • strcpy
  • wcscpy
RtlStringCbCopyA 和 RtlStringCbCopyW 不會取代 strncpy。 若要取代 strncpy，請使用 RtlStringCbCopyN 或 RtlStringCbCopyNEx。

目的地緩衝區的大小會提供給 函式，以確保 RtlStringCbCopy 不會寫入緩衝區結尾。

使用 RtlStringCbCopyW 來處理 Unicode 字串，並 RtlStringCbCopyA 來處理 ANSI 字符串。 您使用的表單取決於您的資料，如下表所示。

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

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

pszSrc 或 pszDest 都不能 NULL。 如果您需要處理 NULL 字串指標值，請使用 RtlStringCbCopyEx。

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

要求

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

另請參閱

RtlStringCbCopyEx

RtlStringCchCopy

  • 上次更新時間：