通过

RtlUnicodeStringCbCopyStringNEx 函数 （ntstrsafe.h）

  • 项目

RtlUnicodeStringCbCopyStringNEx 函数将字符串复制到 UNICODE_STRING 结构中，同时限制复制的字符串的大小。

语法

NTSTRSAFEDDI RtlUnicodeStringCbCopyStringNEx(
  [out]           PUNICODE_STRING  DestinationString,
  [in]            NTSTRSAFE_PCWSTR pszSrc,
  [in]            size_t           cbToCopy,
  [out, optional] PUNICODE_STRING  RemainingString,
  [in]            DWORD            dwFlags
);

参数

[out] DestinationString

自选。 指向接收复制字符串的 UNICODE_STRING 结构的指针。 pszSrc 参数指向（不包括终止 null）的字符串将复制到 DestinationString 参数 UNICODE_STRING 结构指向的缓冲区中。 字符串中的最大字节数为 NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR)。 DestinationString 可以 NULL，但前提是 dwFlags中设置STRSAFE_IGNORE_NULLS。

[in] pszSrc

自选。 指向要复制的字符串的指针。 此指针可以 NULL，但仅在 dwFlags中设置STRSAFE_IGNORE_NULLS时。

[in] cbToCopy

要从源复制到目标的字节数。

[out, optional] RemainingString

自选。 如果调用方提供指向 UNICODE_STRING 结构的非NULL 指针，则该函数会将此结构的 Buffer 成员设置为串联字符串的末尾，将结构的 Length 成员设置为零，并将结构的 MaximumLength 成员设置为目标缓冲区中剩余的字节数。 RemainingString 可以 NULL，但前提是 dwFlags中设置了STRSAFE_IGNORE_NULLS。

[in] dwFlags

一个或多个标志，还可以选择填充字节。 标志的定义如下：

价值 意义
STRSAFE_FILL_BEHIND_NULL 如果设置此标志并且函数成功，则 dwFlags 的低字节用于填充字符串中最后一个字符之后的目标缓冲区部分。
STRSAFE_IGNORE_NULLS 如果设置了此标志，则源或目标指针或两者都可以 NULL。 RtlUnicodeStringCbCopyStringNEx 处理 NULL 源缓冲区指针（如空字符串（TEXT（“”）），可以复制这些指针。 NULL 目标缓冲区指针无法接收无空字符串。
STRSAFE_FILL_ON_FAILURE 如果设置了此标志并且函数失败，则 dwFlags 的低字节用于填充整个目标缓冲区。 此作覆盖任何预先存在的缓冲区内容。
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。
STRSAFE_ZERO_LENGTH_ON_FAILURE 如果设置了此标志并且函数返回STATUS_BUFFER_OVERFLOW，则目标字符串长度设置为零字节。

返回值

RtlUnicodeStringCbCopyStringNEx 返回以下 NTSTATUS 值之一。

返回代码 描述
STATUS_SUCCESS 此 成功 状态意味着源数据存在，并且字符串在没有截断的情况下连接。
STATUS_BUFFER_OVERFLOW 此 警告 状态意味着复制作由于目标缓冲区中的空间不足而未完成。 如果在 dwFlags中设置 STRSAFE_NO_TRUNCATION，则不会修改目标缓冲区。 如果未设置标志，则目标缓冲区包含复制的字符串的截断版本。
STATUS_INVALID_PARAMETER 此 错误 状态意味着函数收到了无效的输入参数。 有关详细信息，请参阅以下列表。

RtlUnicodeStringCbCopyStringNEx 在发生以下任一情况时返回STATUS_INVALID_PARAMETER值：

  • UNICODE_STRING 结构的内容无效。
  • dwFlags中指定了无效标志。
  • 目标缓冲区已满。
  • 缓冲区指针 NULL，dwFlags中未指定STRSAFE_IGNORE_NULLS标志。
  • 目标缓冲区指针 NULL，但缓冲区大小不为零。
  • 目标缓冲区指针 NULL，或其长度为零，但存在非零长度源字符串。
  • cbToCopy 参数的值大于 NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof（WCHAR）。

有关如何测试 NTSTATUS 值的信息，请参阅 使用 NTSTATUS 值。

言论

RtlUnicodeStringCbCopyStringNEx 函数使用目标缓冲区的大小来确保复制作不会写入缓冲区末尾。 默认情况下，函数不会 不 终止结果字符串，其值为 null 字符值（即零）。 作为选项，调用方可以使用STRSAFE_FILL_BEHIND标志和填充字节值零到 null 终止不占用整个目标缓冲区的结果字符串。

RtlUnicodeStringCbCopyStringNEx 通过返回一个标识目标字符串末尾的 UNICODE_STRING 结构以及该字符串中未使用的字节数，从而添加到 RtlUnicodeStringCbCopyStringN 函数的功能。 可以传递 RtlUnicodeStringCbCopyStringNEx 的标志以获取其他控件。

如果源字符串和目标字符串重叠，则函数的行为是未定义的。

除非在 dwFlags 中设置了STRSAFE_IGNORE_NULLS标志，否则 pszSrc 和 DestinationString 指针不能 NULL。 如果设置了STRSAFE_IGNORE_NULLS，则可以 NULL其中一个或两个指针。 如果 DestinationString 指针 NULL，则 pszSrc 指针必须 NULL 或指向空字符串。

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

要求

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

另请参阅