Функция RtlUnicodeStringCopy (ntstrsafe.h)

Функция RtlUnicodeStringCopy копирует строку из одной UNICODE_STRING структуры в другую.

Синтаксис

NTSTRSAFEDDI RtlUnicodeStringCopy(
  [out] PUNICODE_STRING  DestinationString,
  [in]  PCUNICODE_STRING SourceString
);

Параметры

[out] DestinationString

Указатель на структуру UNICODE_STRING. Исходная строка копируется в целевую строку. Максимальное количество байтов в строковом буфере структуры — NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR).

[in] SourceString

Указатель на структуру UNICODE_STRING. Эта структура включает буфер, содержащий исходную строку. Эта строка будет скопирована в целевую строку. Максимальное количество байтов в строковом буфере структуры — NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR).

Возвращаемое значение

RtlUnicodeStringCopy возвращает одно из следующих значений NTSTATUS.

Возвращаемый код Описание
STATUS_SUCCESS
 Это успешном состоянии означает, что исходные данные были представлены, строка была скопирована без усечения, а результирующий целевой буфер завершается значением NULL.
STATUS_BUFFER_OVERFLOW
 Это предупреждение о состоянии означает, что операция копирования не завершена из-за нехватки буферного пространства. Буфер назначения содержит усеченную версию исходной строки.
STATUS_INVALID_PARAMETER
 Это состояние означает, что функция получила недопустимый входной параметр. Дополнительные сведения см. в следующем списке.
 

RtlUnicodeStringCopy возвращает значение STATUS_INVALID_PARAMETER при возникновении одной из следующих ситуаций:

  • Содержимое структуры UNICODE_STRING недопустимо.
  • Буфер назначения уже заполнен.
  • Указатель буфера NULL.
  • Длина целевого буфера равна нулю, но в исходной строке ненулевой длины присутствует.
Сведения об тестировании значений NTSTATUS см. в использование значений NTSTATUS.

Замечания

Функция RtlUnicodeStringCopy использует размер буфера назначения, чтобы убедиться, что операция копирования не записывается в конец буфера. Если строка должна быть усечена в конце целевого буфера, функция не завершает результируемую строку с пустым символом.

Если исходные и конечные строки перекрываются, поведение функции не определено.

Указатели SourceString и DestinationString не могут быть NULL. Если необходимо обработать значения указателя null , используйте функцию RtlUnicodeStringCopyEx.

Дополнительные сведения о функциях безопасной строки см. в разделе Использование безопасных строковых функций.

Требования

Требование Ценность
минимальные поддерживаемые клиентские Доступно в Windows XP с пакетом обновления 1 (SP1) и более поздними версиями Windows.
целевая платформа Настольный
заголовка ntstrsafe.h (include Ntstrsafe.h)
библиотеки Ntstrsafe.lib
IRQL Любой, если управляемые строки всегда находятся в памяти, в противном случае PASSIVE_LEVEL

См. также

RtlUnicodeStringCopyEx

UNICODE_STRING

  • Last updated on