RtlUnicodeStringCchCopyNEx 函数 (ntstrsafe.h)

  • 项目

RtlUnicodeStringCchCopyNEx 函数将字符串从一个UNICODE_STRING结构复制到另一个结构，同时限制复制的字符串的大小。

语法

NTSTRSAFEDDI RtlUnicodeStringCchCopyNEx(
  [out]           PUNICODE_STRING  DestinationString,
  [in]            PCUNICODE_STRING SourceString,
  [in]            size_t           cchToCopy,
  [out, optional] PUNICODE_STRING  RemainingString,
  [in]            DWORD            dwFlags
);

参数

[out] DestinationString

可选。 指向接收复制字符串 的 UNICODE_STRING 结构的指针。 SourceString 参数UNICODE_STRING结构指向的字符串将复制到 DestinationString 参数UNICODE_STRING结构指向的缓冲区。 结构字符串缓冲区中的最大字符数NTSTRSAFE_UNICODE_STRING_MAX_CCH。 DestinationString 可以为 NULL，但前提是在 dwFlags 中设置了STRSAFE_IGNORE_NULLS。

[in] SourceString

可选。 指向包含要复制的字符串 的UNICODE_STRING 结构的指针。 结构的字符串缓冲区中的最大字符数为 NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR)。 SourceString 可以为 NULL，但前提是在 dwFlags 中设置了STRSAFE_IGNORE_NULLS。

[in] cchToCopy

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

[out, optional] RemainingString

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

[in] dwFlags

一个或多个标志以及填充字节（可选）。 这些标志的定义如下：

值 含义
STRSAFE_FILL_BEHIND 如果设置了此标志并且函数成功，则 dwFlags 的低字节用于填充字符串中最后一个字符后面的目标缓冲区部分。
STRSAFE_IGNORE_NULLS 如果设置了此标志，则源指针和/或目标指针可以为 NULL。 RtlUnicodeStringCchCopyNEx 将 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，则目标字符串长度设置为零字节。

返回值

RtlUnicodeStringCchCopyNEx 返回以下 NTSTATUS 值之一。

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

发生下列情况之一时，RtlUnicodeStringCchCopyNEx 返回STATUS_INVALID_PARAMETER值：

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

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

注解

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

RtlUnicodeStringCchCopyNEx 通过返回标识目标字符串末尾和该字符串中未使用的字节数的UNICODE_STRING结构，增加了 RtlUnicodeStringCchCopyN 函数的功能。 可以将标志传递给 RtlUnicodeStringCchCopyNEx 以获取其他控件。

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

除非在 dwFlags 中设置了STRSAFE_IGNORE_NULLS标志，否则SourceString 和 DestinationString 指针不能为 NULL。 如果设置了STRSAFE_IGNORE_NULLS，则其中一个或两个指针可以为 NULL。 如果 DestinationString 指针为 NULL，则 SourceString 指针必须为 NULL ，或者 UNICODE_STRING 结构必须包含空字符串。

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

要求

要求 值
最低受支持的客户端 从 Windows XP Service Pack 1 (SP1) 开始可用。
目标平台 桌面
标头 ntstrsafe.h (包括 Ntstrsafe.h)
Library Ntstrsafe.lib
IRQL PASSIVE_LEVEL

另请参阅