通过

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 函数的功能。 可以将标志传递给函数以获取其他控件。

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

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

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

要求

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

另请参阅