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

Статья
02/07/2025

Функции RtlStringCchCopyW и RtlStringCchCopyA копируют строку источника, завершающую значение NULL, в целевой буфер указанной длины.

Синтаксис

NTSTRSAFEDDI RtlStringCchCopyA(
  [out] NTSTRSAFE_PSTR  pszDest,
  [in]  size_t          cchDest,
  [in]  NTSTRSAFE_PCSTR pszSrc
);

Параметры

[out] pszDest

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

[in] cchDest

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

[in] pszSrc

Указатель на строку, предоставляемую вызывающим, завершаемую значением NULL.

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

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

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

Возвращаемый код

Описание

STATUS_SUCCESS

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

STATUS_BUFFER_OVERFLOW

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

STATUS_INVALID_PARAMETER

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

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

Значение в cchDest больше максимального размера буфера.
Присутствует указатель NULL.
Длина целевого буфера была нулевой при входе.

Замечания

RtlStringCchCopyW и RtlStringCchCopyA следует использовать вместо следующих функций:

strcpy
wcscpy

Эти функции не заменяются strncpy. Используйте RtlStringCchCopyN или RtlStringCchCopyNEx для замены strncpy.

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

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

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

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

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

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

Требования

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

См. также

RtlStringCbCopy

RtlStringCchCopyEx

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