通过

RtlStringCchCopyA 函数 （ntstrsafe.h）

  • 项目

RtlStringCchCopyW 和 RtlStringCchCopyA 函数将以 null 结尾的源字符串复制到指定长度的目标缓冲区中。

语法

NTSTRSAFEDDI RtlStringCchCopyA(
  [out] NTSTRSAFE_PSTR  pszDest,
  [in]  size_t          cchDest,
  [in]  NTSTRSAFE_PCSTR pszSrc
);

参数

[out] pszDest

指向接收复制字符串的调用方提供的缓冲区的指针。 pszSrc 处的字符串将复制到 pszDest 处的缓冲区，并使用 null 字符终止。

[in] cchDest

目标缓冲区的大小（以字符为单位）。 允许的最大字符数是NTSTRSAFE_MAX_CCH。

[in] pszSrc

指向调用方提供的 null 终止字符串的指针。

返回值

该函数返回下表中列出的 NTSTATUS 值之一。 有关如何测试 NTSTATUS 值的信息，请参阅 使用 NTSTATUS 值。

返回代码 描述
STATUS_SUCCESS
 此 成功 状态意味着源数据存在，字符串在没有截断的情况下复制，生成的目标缓冲区为 null 终止。
STATUS_BUFFER_OVERFLOW
 此 警告 状态意味着复制作由于缓冲区空间不足而未完成。 目标缓冲区包含预期结果的截断、以 null 结尾的版本。
STATUS_INVALID_PARAMETER
 此 错误 状态意味着函数收到了无效的输入参数。 有关详细信息，请参阅以下段落。

此函数在以下情况下返回STATUS_INVALID_PARAMETER值：

  • cchDest 中的值大于最大缓冲区大小。
  • 存在 NULL 指针。
  • 目标缓冲区长度在条目处为零。

言论

应使用 RtlStringCchCopyW 和 RtlStringCchCopyA，而不是使用以下函数：

  • strcpy
  • wcscpy
这些函数不能替换 strncpy。 使用 RtlStringCchCopyN 或 RtlStringCchCopyNEx 替换 strncpy。

目标缓冲区的大小（以字符为单位）提供给 RtlStringCchCopyW，RtlStringCchCopyA，以确保它们不会写入缓冲区末尾。

使用 RtlStringCchCopyW 来处理 Unicode 字符串和 RtlStringCchCopyA 来处理 ANSI 字符串。 使用的表单取决于数据，如下表所示。

字符串数据类型 字符串文本 功能
WCHAR L“string” RtlStringCchCopyW
char “string” RtlStringCchCopyA
 

如果 pszSrc 和 pszDest 指向重叠字符串，则函数的行为是未定义的。

pszSrc 和 pszDest 都不能 NULL。 如果需要处理 NULL 字符串指针值，请使用 RtlStringCchCopyEx。

有关安全字符串函数的详细信息，请参阅 使用安全字符串函数。

要求

要求 价值
最低支持的客户端 在 Windows XP 中提供 Service Pack 1（SP1）和更高版本的 Windows。
目标平台 桌面
标头 ntstrsafe.h （包括 Ntstrsafe.h）
库 Ntstrsafe.lib
IRQL 如果正在作的字符串始终驻留在内存中，则为任何字符串，否则PASSIVE_LEVEL

另请参阅

RtlStringCbCopy

RtlStringCchCopyEx