RtlStringCchCopyNW 函式 (ntstrsafe.h)

  • 發行項

RtlStringCchCopyNW 和 RtlStringCchCopyNA 函式會將字元計數位符串複製到緩衝區，同時限制複製字串的大小。

語法

NTSTRSAFEDDI RtlStringCchCopyNW(
  [out] NTSTRSAFE_PWSTR pszDest,
  [in]  size_t          cchDest,
  [in]  STRSAFE_PCNZWCH pszSrc,
        size_t          cchToCopy
);

參數

[out] pszDest

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

[in] cchDest

目的地緩衝區的大小，以字元為單位。 允許的最大字元數是NTSTRSAFE_MAX_CCH。

[in] pszSrc

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

cchToCopy

要從 pszSrc 複製到 pszDest 所提供的緩衝區的最大字元數。

傳回值

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

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

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

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

備註

應該使用 RtlStringCchCopyNW 和 RtlStringCchCopyNA ，而不是 strncpy。

函式會從來源字串複製指定的字元數。 RtlStringCchCopyNW 和 RtlStringCchCopyNA 會接收目的地緩衝區的大小，以字元為單位，以確保函式不會寫入緩衝區結尾。

請注意，這些函式在一方面與 strncpy 的行為不同。 如果 cchSrc 大於 pszSrc 中的字元數，則在複製 cchSrc 字元之前，RtlStringCchCopyNW 和 RtlStringCchCopyNA 不會繼續以 Null 字元填補 pszDest。

使用 RtlStringCchCopyNW 來處理 Unicode 字串和 RtlStringCchCopyNA 來處理 ANSI 字串。 您使用的表單取決於您的資料，如下表所示。

字串資料類型 字串常值 函式
WCHAR L“string” RtlStringCchCopyNW
char "字串" RtlStringCchCopyNA
 

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

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

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

規格需求

需求 值
最低支援的用戶端 Windows XP 中提供 Service Pack 1 (SP1) 和更新版本的 Windows。
目標平台 桌面
標頭 ntstrsafe.h (包含 Ntstrsafe.h)
程式庫 Ntstrsafe.lib
IRQL 如果正在操作的字串一律位於記憶體中，則為任何 ，否則PASSIVE_LEVEL

另請參閱

RtlStringCbCopyN

RtlStringCchCopy

RtlStringCchCopyNEx