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

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

Синтаксис

NTSTRSAFEDDI RtlStringCchCatNW(
  [in, out] NTSTRSAFE_PWSTR pszDest,
  [in]      size_t          cchDest,
  [in]      STRSAFE_PCNZWCH pszSrc,
            size_t          cchToAppend
);

Параметры

[in, out] pszDest

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

[in] cchDest

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

[in] pszSrc

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

cchToAppend

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

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

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

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

Комментарии

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

• strncat
• wcsncat

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

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

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

 

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

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

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

Требования

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

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

RtlStringCbCatN

RtlStringCchCat

RtlStringCchCatNEx