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

Функция RtlUnicodeStringCchCatStringN объединяет две строки, если целевая строка содержится в структуре UNICODE_STRING, ограничивая размер добавленной строки.

Синтаксис

NTSTRSAFEDDI RtlUnicodeStringCchCatStringN(
  [in, out] PUNICODE_STRING  DestinationString,
  [in]      NTSTRSAFE_PCWSTR pszSrc,
  [in]      size_t           cchToAppend
);

Параметры

[in, out] DestinationString

Указатель на структуру UNICODE_STRING. Эта структура содержит буфер, содержащий строку, к которой будет сцеплена исходная строка. В выходных данных этот буфер является целевым буфером, который содержит всю результирующую строку. Исходная строка (за исключением конца NULL) добавляется в конец конечной строки. Максимальное количество символов в строковом буфере структуры — NTSTRSAFE_UNICODE_STRING_MAX_CCH.

[in] pszSrc

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

[in] cchToAppend

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

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

RtlUnicodeStringCchCatStringN возвращает одно из следующих значений NTSTATUS.

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

RtlUnicodeStringCchCatStringN возвращает значение STATUS_INVALID_PARAMETER при возникновении одной из следующих ситуаций:

  • Содержимое структуры UNICODE_STRING недопустимо.
  • Буфер назначения уже заполнен.
  • Указатель буфера NULL.
  • Длина целевого буфера равна нулю, но в исходной строке ненулевой длины присутствует.
  • Значение параметра cchToAppend больше NTSTRSAFE_UNICODE_STRING_MAX_CCH.
Сведения об тестировании значений NTSTATUS см. в использование значений NTSTATUS.

Замечания

Функция RtlUnicodeStringCchCatStringN использует размер буфера назначения, чтобы убедиться, что операция объединения не записывает в конец буфера. Функция не завершает результирующая строка со значением NULL (то есть с нулем).

Если исходные и конечные строки перекрываются, поведение функции не определено.

Указатели pszS rc и DestinationString нельзя null. Если необходимо обрабатывать значения указателя NULL NULL, используйте функцию RtlUnicodeStringCchCatStringNEx.

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

Требования

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

См. также

RtlUnicodeStringCbCatStringN

RtlUnicodeStringCchCatStringNEx

UNICODE_STRING

  • Last updated on