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

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

Синтаксис

NTSTRSAFEDDI RtlStringCbCatNA(
  [in, out] NTSTRSAFE_PSTR pszDest,
  [in]      size_t         cbDest,
  [in]      STRSAFE_PCNZCH pszSrc,
            size_t         cbToAppend
);

Параметры

[in, out] pszDest

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

[in] cbDest

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

Для строк Юникода максимальное число байтов равно NTSTRSAFE_MAX_CCH * sizeof(WCHAR).

Для строк ANSI максимальное число байтов равно NTSTRSAFE_MAX_CCH * sizeof(char).

[in] pszSrc

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

cbToAppend

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

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

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

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

Комментарии

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

• strncat
• wcsncat

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

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

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

 

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

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

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

Требования

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

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

RtlStringCbCat

RtlStringCbCatNEx

RtlStringCchCatN