RtlUnicodeStringInitEx 函数 (ntstrsafe.h)

  • 项目

RtlUnicodeStringInitEx 函数初始化UNICODE_STRING结构。

语法

NTSTRSAFEDDI RtlUnicodeStringInitEx(
  [out]          PUNICODE_STRING  DestinationString,
  [in, optional] NTSTRSAFE_PCWSTR pszSrc,
  [in]           DWORD            dwFlags
);

参数

[out] DestinationString

可选。 指向要初始化 的UNICODE_STRING 结构的指针。 pszSrc 指针将复制到 DestinationString 参数的UNICODE_STRING结构中。 pszSrc 指向的字符串中的最大字符数是NTSTRSAFE_UNICODE_STRING_MAX_CCH。 DestinationString 可以为 NULL，但前提是在 dwFlags 中设置了STRSAFE_IGNORE_NULLS。

[in, optional] pszSrc

可选。 指向以 null 结尾的字符串常量的指针。 此字符串指针将复制到 DestinationString 参数指向的 UNICODE_STRING 结构的 Buffer 成员。 此字符串指针可以为 NULL。

[in] dwFlags

定义了以下标志：

STRSAFE_IGNORE_NULLS

如果设置了此标志，则源指针可以为 NULL。 RtlUnicodeStringInitEx 将 NULL 源缓冲区指针视为空字符串 (可以复制的 TEXT (“”) ) 。

返回值

RtlUnicodeStringInitEx 返回以下 NTSTATUS 值之一。

返回代码 说明
STATUS_SUCCESS
 此 成功 状态表示存在源数据，复制字符串时未截断，结果目标缓冲区以 null 结尾。
STATUS_INVALID_PARAMETER
 此错误状态表示函数收到了无效的输入参数。 有关详细信息，请参阅以下列表。
 

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

  • pszSrc 参数指向的字符串长度大于 NTSTRSAFE_UNICODE_STRING_MAX_CCH 个字符。
  • DestinationString 指针为 NULL，但 pszSrc 指针不为 NULL。
有关如何测试 NTSTATUS 值的信息，请参阅 使用 NTSTATUS 值。

注解

RtlUnicodeStringInitEx 函数执行以下操作：

  • 将 UNICODE_STRING 结构的 Length 成员设置为 pszSrc 参数指向的字符串的长度（以字节为单位）。
  • 将 UNICODE_STRING 结构的 MaximumLength 成员设置为 pszSrc 参数指向的字符串的长度（以字节为单位）加上 2 个字节。
  • 将 UNICODE_STRING 结构的 Buffer 成员设置为 pszSrc 参数指定的地址。
除非设置了STRSAFE_IGNORE_NULLS标志， 否则 DestinationString 指针不能为 NULL 。

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

要求

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

另请参阅

RtlUnicodeStringInit

UNICODE_STRING