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

Статья
02/07/2025

Функция RtlUnicodeStringCbCopyStringN копирует строку в структуру UNICODE_STRING при ограничении размера скопированной строки.

Синтаксис

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

Параметры

[out] DestinationString

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

[in] pszSrc

Указатель на строку для копирования.

[in] cbToCopy

Количество байтов, скопированных из источника в место назначения.

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

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

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

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

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

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

Замечания

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

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

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

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

Требования

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

См. также

RtlUnicodeStringCbCopyNEx

RtlUnicodeStringCchCopyN

UNICODE_STRING

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