RtlStringCbCopyUnicodeString 函数 (ntstrsafe.h)

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

语法

NTSTRSAFEDDI RtlStringCbCopyUnicodeString(
  [out] NTSTRSAFE_PWSTR  pszDest,
  [in]  size_t           cbDest,
  [in]  PCUNICODE_STRING SourceString
);

参数

[out] pszDest

指向接收复制字符串的缓冲区的指针。 SourceString 参数UNICODE_STRING结构指向的字符串将复制到 pszDest 处的缓冲区,并用空字符终止。

[in] cbDest

pszDest 指向的目标缓冲区的大小(以字节为单位)。 缓冲区必须足够大,才能包含字符串和终止 null 字符。 缓冲区中的最大字节数为 NTSTRSAFE_UNICODE_STRING_MAX_CCH * size of (WCHAR) 。

[in] SourceString

指向包含要复制的字符串 的UNICODE_STRING 结构的指针。 字符串中的最大字节数为 NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof (WCHAR) 。

返回值

RtlStringCbCopyUnicodeString 返回以下 NTSTATUS 值之一。

返回代码 说明
STATUS_SUCCESS
成功 状态表示存在源数据,复制字符串时未截断,结果目标缓冲区以 null 结尾。
STATUS_BUFFER_OVERFLOW
警告 状态表示复制操作由于缓冲区空间不足而未完成。 目标缓冲区包含截断的、以 null 结尾的预期结果版本。
STATUS_INVALID_PARAMETER
此错误状态表示函数收到了无效的输入参数。 有关详细信息,请参阅以下列表。
 

发生下列情况之一时,RtlStringCbCopyUnicodeString 返回STATUS_INVALID_PARAMETER值:

  • UNICODE_STRING 结构的内容无效。
  • cbDest 中的值大于最大缓冲区大小。
  • pszDest 指向的目标缓冲区 () 已满。
  • 缓冲区指针为 NULL
  • 目标缓冲区的长度为零,但存在非零长度源字符串。
有关如何测试 NTSTATUS 值的信息,请参阅 使用 NTSTATUS 值

注解

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

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

SourceString pszDest 指针不能为 NULL。 如果需要处理 NULL 指针值,请使用 RtlStringCbCopyUnicodeStringEx 函数。

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

要求

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

另请参阅

RtlStringCbCopyUnicodeStringEx

RtlStringCchCopyUnicodeString

UNICODE_STRING