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

Статья
05/03/2024

Функции RtlStringCchCopyNW и RtlStringCchCopyNA копируют строку с подсчетом символов в буфер, ограничивая размер скопированной строки.

Синтаксис

NTSTRSAFEDDI RtlStringCchCopyNW(
  [out] NTSTRSAFE_PWSTR pszDest,
  [in]  size_t          cchDest,
  [in]  STRSAFE_PCNZWCH pszSrc,
        size_t          cchToCopy
);

Параметры

[out] pszDest

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

[in] cchDest

Размер буфера назначения в символах. Максимально допустимое количество символов — NTSTRSAFE_MAX_CCH.

[in] pszSrc

Указатель на предоставленную вызывающей, завершаемую null строкой.

cchToCopy

Максимальное количество символов для копирования из pszSrc в буфер, предоставленный pszDest.

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

Функция возвращает одно из значений NTSTATUS, перечисленных в следующей таблице. Сведения о проверке значений NTSTATUS см. в разделе Использование значений NTSTATUS.

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

Код возврата

Описание

STATUS_SUCCESS

Это состояние успешного выполнения означает, что исходные данные присутствуют, строка была скопирована без усечения, а результирующий буфер назначения завершается null.

STATUS_BUFFER_OVERFLOW

Это состояние предупреждения означает, что операция копирования не завершена из-за нехватки места в буфере назначения. Буфер назначения содержит усеченную версию скопированной строки.

STATUS_INVALID_PARAMETER

Это состояние ошибки означает, что функция получила недопустимый входной параметр. Дополнительные сведения см. в следующем абзаце.

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

Значение в cchDest больше максимального размера буфера.
Буфер назначения уже заполнен.
Существовал указатель NULL .
Длина буфера назначения равна нулю, но при этом присутствовала строка источника ненулевой длины.

Функции копируют заданное количество символов из исходной строки. RtlStringCchCopyNW и RtlStringCchCopyNA получают размер буфера назначения в символах, чтобы гарантировать, что функции не записываются за конец буфера.

Обратите внимание, что эти функции ведут себя иначе, чем strncpy в одном отношении. Если значение cchSrc больше, чем число символов в pszSrc, RtlStringCchCopyNW и RtlStringCchCopyNA , в отличие от strncpy, не продолжайте заполнять pszDest символами NULL до тех пор, пока не будут скопированы символы cchSrc .

Используйте RtlStringCchCopyNW для обработки строк Юникода и RtlStringCchCopyNA для обработки строк ANSI. Используемая форма зависит от данных, как показано в следующей таблице.

Строковый тип данных	Строковый литерал	Функция
WCHAR	L"string"	RtlStringCchCopyNW
char	Строка	RtlStringCchCopyNA

Если pszSrc и pszDest указывают на перекрывающиеся строки, поведение функции не определено.

Ни pszSrc, ни pszDest не могут иметь значение NULL. Если необходимо обработать значения указателя строки NULL , используйте RtlStringCchCopyNEx.

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

Требования

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

См. также раздел

RtlStringCbCopyN

RtlStringCchCopy

RtlStringCchCopyNEx

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