RtlUnicodeStringCbCopyStringN 函数 (ntstrsafe.h)

RtlUnicodeStringCbCopyStringN 函数将字符串复制到UNICODE_STRING结构中,同时限制复制的字符串的大小。

语法

NTSTRSAFEDDI RtlUnicodeStringCbCopyStringN(
  [out] PUNICODE_STRING  DestinationString,
  [in]  NTSTRSAFE_PCWSTR pszSrc,
  [in]  size_t           cbToCopy
);

参数

[out] DestinationString

指向接收复制字符串 的UNICODE_STRING 结构的指针。 pszSrc 参数指向 (排除终止 null) 的字符串将复制到 DestinationString 参数UNICODE_STRING结构指向的缓冲区中。 字符串中的最大字节数为 NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof (WCHAR) 。

[in] pszSrc

指向要复制的字符串的指针。

[in] cbToCopy

要从源复制到目标的字节数。

返回值

RtlUnicodeStringCbCopyN 返回以下 NTSTATUS 值之一。

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

发生以下任一情况时,RtlUnicodeStringCbCopyN 返回STATUS_INVALID_PARAMETER值:

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

备注

RtlUnicodeStringCbCopyN 函数使用目标缓冲区的大小来确保复制操作不会写入缓冲区末尾。 该函数 不会 终止结果字符串,其值为 null 字符值 (,即零) 。

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

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

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

要求

   
最低受支持的客户端 在 Windows XP 中提供 Service Pack 1 (SP1) 及更高版本的 Windows。
目标平台 桌面
Header ntstrsafe.h (包括 Ntstrsafe.h)
Library Ntstrsafe.lib
IRQL PASSIVE_LEVEL

另请参阅

RtlUnicodeStringCbCopyNEx

RtlUnicodeStringCchCopyN

UNICODE_STRING