RtlStringCbCopyExA 函数 (ntstrsafe.h)

  • 项目

RtlStringCbCopyExW 和 RtlStringCbCopyExA 函数将字节计数的字符串复制到缓冲区中。

语法

NTSTRSAFEDDI RtlStringCbCopyExA(
  [out, optional] NTSTRSAFE_PSTR  pszDest,
  [in]            size_t          cbDest,
  [in, optional]  NTSTRSAFE_PCSTR pszSrc,
  [out, optional] NTSTRSAFE_PSTR  *ppszDestEnd,
  [out, optional] size_t          *pcbRemaining,
  [in]            DWORD           dwFlags
);

参数

[out, optional] pszDest

指向调用方提供的缓冲区的指针，该缓冲区接收复制的字符串。 pszSrc 处的字符串将复制到 pszDest 处的缓冲区，并用 null 字符终止。 pszDest 指针可以为 NULL，但前提是在 dwFlags 中设置了STRSAFE_IGNORE_NULLS。

[in] cbDest

目标缓冲区的大小（以字节为单位）。 缓冲区必须足以容纳字符串和终止 null 字符。

对于 Unicode 字符串，最大字节数为 NTSTRSAFE_MAX_CCH * sizeof(WCHAR)

对于 ANSI 字符串，最大字节数为 NTSTRSAFE_MAX_CCH * sizeof(char)

如果 pszDest 为 NULL， 则 cbDest 必须为零。

[in, optional] pszSrc

指向调用方提供的以 null 结尾的字符串的指针。 pszSrc 指针可以为 NULL，但前提是在 dwFlags 中设置了STRSAFE_IGNORE_NULLS。

[out, optional] ppszDestEnd

如果调用方提供非 NULL 地址指针，则在复制操作完成后，函数会使用指向目标缓冲区生成的 NULL 字符串终止符的指针加载该地址。

[out, optional] pcbRemaining

如果调用方提供非 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 此 警告 状态表示由于目标缓冲区中的空间不足，复制操作未完成。 如果设置了 STRSAFE_NO_TRUNCATION ，请参阅 dwFlags 参数了解详细信息。
STATUS_INVALID_PARAMETER

此错误状态表示函数收到了无效的输入参数。 有关详细信息，请参阅以下段落。

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

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

注解

应使用 RtlStringCbCopyExA 和 RtlStringCbCopyExW，而不是以下函数：

  • strcpy
  • wcscpy

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

RtlStringCbCopyEx 通过返回指向目标字符串末尾的指针以及该字符串中剩余未使用的字节数，增加了 RtlStringCbCopy 的功能。 标志可以传递给 函数以用于其他控制。

使用 RtlStringCbCopyExW 处理 Unicode 字符串，使用 RtlStringCbCopyExA 处理 ANSI 字符串。 使用的窗体取决于下表中所示的数据。

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

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

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

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

要求

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

另请参阅