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

Статья
02/07/2025

Функция RtlUnicodeStringCopyString копирует строку в структуру UNICODE_STRING.

Синтаксис

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

Параметры

[out] DestinationString

Указатель на структуру UNICODE_STRING, которая получает скопированную строку. Строка, на которую указывает параметр pszSrc (за исключением конечного null), копируется в буфер, на который указывает UNICODE_STRINGUNICODE_STRING структуре параметра. Максимальное количество байтов в строке — NTSTRSAFE_UNICODE_STRING_MAX_CCH * размер(WCHAR).

[in] pszSrc

Указатель на строку, завершаемую значением NULL. Эта строка будет скопирована в буфер, на который указывает структура UNICODE_STRING параметра destinationString DestinationString.

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

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

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

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

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

Сведения об тестировании значений NTSTATUS см. в использование значений NTSTATUS.

Замечания

Функция RtlUnicodeStringCopyString использует размер буфера назначения, чтобы убедиться, что операция объединения не записывается в конец буфера. Функция не завершает результирующая строка с символом NULL.

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

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

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

Требования

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

См. также

RtlUnicodeStringCopyStringEx

UNICODE_STRING

Поделиться через