RtlStringCchCopyUnicodeStringEx 函数 (ntstrsafe.h)

  • 项目

RtlStringCchCopyUnicodeStringEx 函数将UNICODE_STRING结构的内容复制到指定目标。

语法

NTSTRSAFEDDI RtlStringCchCopyUnicodeStringEx(
  [out]           NTSTRSAFE_PWSTR  pszDest,
  [in]            size_t           cchDest,
  [in]            PCUNICODE_STRING SourceString,
  [out]           NTSTRSAFE_PWSTR  *ppszDestEnd,
  [out, optional] size_t           *pcchRemaining,
  [in]            DWORD            dwFlags
);

参数

[out] pszDest

可选。 指向接收复制字符串的缓冲区的指针。 SourceString 参数UNICODE_STRING结构指向的字符串将复制到 pszDest 的缓冲区，并用 null 字符终止。 此指针可以为 NULL，但前提是在 dwFlags 中设置了STRSAFE_IGNORE_NULLS。

[in] cchDest

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

[in] SourceString

可选。 指向包含要复制的字符串 的UNICODE_STRING 结构的指针。 字符串中的最大字符数为NTSTRSAFE_UNICODE_STRING_MAX_CCH。 此指针可以为 NULL，但前提是在 dwFlags 中设置了STRSAFE_IGNORE_NULLS。

[out] ppszDestEnd

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

[out, optional] pcchRemaining

可选。 如果调用方提供非 NULL 地址指针，则函数会加载包含 pszDest 指向的缓冲区中未使用的字符数的地址，包括终止 null 字符。

[in] dwFlags

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

值 含义
STRSAFE_FILL_BEHIND_NULL 如果设置了此标志并且函数成功，则 dwFlags 的低字节用于填充终止 null 字符后面的目标缓冲区部分。
STRSAFE_IGNORE_NULLS 如果设置了此标志，则源指针和/或目标指针可以为 NULL。 RtlStringCchCopyUnicodeStringEx 将 NULL 源缓冲区指针视为空字符串 (TEXT (“”) ) （可复制）。 NULL 目标缓冲区指针无法接收非空字符串。
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 。

返回值

RtlStringCchCopyUnicodeStringEx 返回以下 NTSTATUS 值之一。

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

发生以下情况之一时，RtlStringCchCopyUnicodeStringEx 返回STATUS_INVALID_PARAMETER值：

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

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

注解

RtlStringCchCopyUnicodeStringEx 函数使用目标缓冲区的大小 (cchDest 参数指定) ，以确保复制操作不会写入缓冲区末尾。

RtlStringCchCopyUnicodeStringEx 通过返回指向目标字符串末尾的指针以及该字符串中未使用的字节数，将添加到 RtlStringCchCopyUnicodeString 函数的功能。 可以将标志传递给 函数，以便进行其他控制。

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

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

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

要求

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

另请参阅