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

Статья
02/07/2025

RtlStringCchCatW и функции RtlStringCchCatA объединяют две строки с подсчетом символов.

Синтаксис

NTSTRSAFEDDI RtlStringCchCatW(
  [in, out] NTSTRSAFE_PWSTR  pszDest,
  [in]      size_t           cchDest,
  [in]      NTSTRSAFE_PCWSTR pszSrc
);

Параметры

[in, out] pszDest

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

[in] cchDest

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

[in] pszSrc

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

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

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

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

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

Описание

STATUS_SUCCESS

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

STATUS_BUFFER_OVERFLOW

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

STATUS_INVALID_PARAMETER

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

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

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

Замечания

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

strcat
wcscat

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

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

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

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

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

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

Требования

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

См. также

RtlStringCbCat

RtlStringCchCatEx

RtlStringCchCatN

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