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

Функции RtlStringCbCatW и RtlStringCbCatA объединяют две строки с подсчетом байтов.

Синтаксис

NTSTRSAFEDDI RtlStringCbCatW(
  [in, out] NTSTRSAFE_PWSTR  pszDest,
  [in]      size_t           cbDest,
  [in]      NTSTRSAFE_PCWSTR pszSrc
);

Параметры

[in, out] pszDest

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

[in] cbDest

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

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

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

[in] pszSrc

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

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

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

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

Комментарии

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

• strcat
• wcscat

Так как RtlStringCbCatW и RtlStringCbCatA получают размер буфера назначения в качестве входных данных, они не будут записывать данные после конца буфера.

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

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

 

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

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

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

Требования

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

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

RtlStringCbCatEx

RtlStringCbCatNEx

RtlStringCchCatEx