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

Статья
02/07/2025

Функция RtlStringCbCopyUnicodeString копирует содержимое структуры UNICODE_STRING в указанное назначение.

Синтаксис

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

Параметры

[out] pszDest

Указатель на буфер, получающий скопированную строку. Строка , на которую указывает UNICODE_STRINGUNICODE_STRING параметра SourceStr ing, копируется в буфер по адресу pszDest и завершается значением NULL.

[in] cbDest

Размер в байтах целевого буфера, на который pszDest указывает. Буфер должен быть достаточно большим, чтобы содержать строку и завершающий символ NULL. Максимальное количество байтов в буфере — NTSTRSAFE_UNICODE_STRING_MAX_CCH * размер(WCHAR).

[in] SourceString

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

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

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

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

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

Содержимое структуры UNICODE_STRING недопустимо.
Значение в cbDest больше максимального размера буфера.
Целевой буфер (который pszDest указывает на) уже заполнен.
Указатель буфера NULL.
Длина целевого буфера равна нулю, но в исходной строке ненулевой длины присутствует.

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

Замечания

Функция r RtlStringCbCopyUnicodeString использует размер буфера назначения (который указывает параметр cbDest cbDest), чтобы убедиться, что операция копирования не записывается в конец буфера.

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

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

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

Требования

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

См. также

RtlStringCbCopyUnicodeStringEx

RtlStringCchCopyUnicodeString

UNICODE_STRING

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