RtlUnicodeStringInit 函数 (ntstrsafe.h)

RtlUnicodeStringInit 函数初始化 UNICODE_STRING 结构。

语法

NTSTRSAFEDDI RtlUnicodeStringInit(
  [out]          PUNICODE_STRING  DestinationString,
  [in, optional] NTSTRSAFE_PCWSTR pszSrc
);

参数

[out] DestinationString

指向要初始化 UNICODE_STRING 结构的指针。 pszSrc 指针将复制到 DestinationString 参数 UNICODE_STRING 结构中。 pszSrc 指向的字符串中的最大字符数是NTSTRSAFE_UNICODE_STRING_MAX_CCH。

[in, optional] pszSrc

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

返回值

RtlUnicodeStringInit 返回以下 NTSTATUS 值之一。

返回代码 描述
STATUS_SUCCESS
成功 状态意味着源数据存在,字符串在没有截断的情况下复制,结果目标缓冲区以 null 结尾。
STATUS_INVALID_PARAMETER
错误 状态意味着函数收到了无效的输入参数。 有关详细信息,请参阅以下列表。
 

RtlUnicodeStringInit 在发生以下任一情况时返回STATUS_INVALID_PARAMETER值:

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

言论

RtlUnicodeStringInit 函数执行以下操作:

  • pszSrc 参数指向的 UNICODE_STRING 结构的 Length 成员设置为 pszSrc 参数指向的字符串的长度(以字节为单位)。
  • UNICODE_STRING 结构的 MaximumLength 成员设置为 pszSrc 参数指向的字符串长度(以字节为单位)。
  • UNICODE_STRING 结构的 Buffer 成员设置为 pszSrc 参数指定的地址。
DestinationString 指针不应 NULL。 如果需要指定 NULLDestinationString 指针值,请使用 RtlUnicodeStringInitEx 函数。

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

要求

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

另请参阅

RtlUnicodeStringInitEx

UNICODE_STRING