RtlStringCchCopyExW 函数 (ntstrsafe.h)

RtlStringCchCopyExWRtlStringCchCopyExA 函数将字符计数的字符串复制到缓冲区中。

语法

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。 如果 pszDestNULL则 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
如果 set 和函数失败,则使用 dwFlags 的低字节填充整个目标缓冲区,并且缓冲区以 null 结尾。 此操作将覆盖任何预先存在的缓冲区内容。
STRSAFE_NULL_ON_FAILURE
如果 set 和函数失败,则目标缓冲区设置为空字符串, (TEXT (“”) ) 。 此操作将覆盖任何预先存在的缓冲区内容。
STRSAFE_NO_TRUNCATION
如果 set 和函数返回STATUS_BUFFER_OVERFLOW,则不会修改目标缓冲区的内容。

返回值

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

返回代码 说明
STATUS_SUCCESS
成功 状态表示源数据存在,字符串被复制而不截断,生成的目标缓冲区以 null 结尾。
STATUS_BUFFER_OVERFLOW
警告 状态表示由于目标缓冲区空间不足,复制操作未完成。 如果在 dwFlags 中设置了STRSAFE_NO_TRUNCATION,则不会修改目标缓冲区。 如果未设置标志,则目标缓冲区包含已创建的字符串的截断版本。
STATUS_INVALID_PARAMETER
此错误状态表示函数收到无效的输入参数。 有关详细信息,请参阅以下段落。

函数在以下情况下返回STATUS_INVALID_PARAMETER值:

  • 指定了无效标志。
  • cchDest 中的值大于最大缓冲区大小。
  • 目标缓冲区已满。
  • 没有STRSAFE_IGNORE_NULLS标志的情况下存在 NULL 指针。
  • 目标缓冲区指针为 NULL,但缓冲区大小不为零。
  • 目标缓冲区指针为 NULL,或者其长度为零,但存在非零长度源字符串。

注解

应使用 RtlStringCchCopyExWRtlStringCchCopyExA,而不是以下函数:

  • strcpy
  • wcscpy
目标缓冲区的大小(以字符为单位)提供给 RtlStringCchCopyExWRtlStringCchCopyExA ,以确保它们不会写入缓冲区末尾。

RtlStringCchCopyExWRtlStringCchCopyExA 通过返回指向目标字符串末尾的指针以及该字符串中未使用的字符数,从而添加到 RtlStringCchCopy 的功能。 可以将标志传递给函数以获取其他控件。 使用 RtlStringCchCopyExW 处理 Unicode 字符串, 使用 RtlStringCchCopyExA 处理 ANSI 字符串。 使用的窗体取决于数据,如下表所示。

字符串数据类型 字符串文本 函数
WCHAR L“string” RtlStringCchCopyExW
char “字符串” RtlStringCchCopyExA
 

如果 pszSrcpszDest 指向重叠字符串,则函数的行为是未定义的。

除非设置了STRSAFE_IGNORE_NULLS标志,否则 pszSrcpszDest 都不能为 NULL ,在这种情况下,两者都可以为 NULL。 如果 pszDestNULLpszSrc 必须为 NULL 或指向空字符串。

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

要求

   
最低受支持的客户端 在 Windows XP 中提供 Service Pack 1 (SP1) 及更高版本的 Windows。
目标平台 桌面
Header ntstrsafe.h (包括 Ntstrsafe.h)
Library Ntstrsafe.lib
IRQL PASSIVE_LEVEL

另请参阅

RtlStringCbCopyEx

RtlStringCchCopy