Функция StringCchCatExA (strsafe.h)
Сцепляет одну строку с другой. Размер буфера назначения предоставляется функции, чтобы гарантировать, что она не будет записывать данные после конца этого буфера.
StringCchCatEx добавляет к функциональным возможностям StringCchCat , возвращая указатель на конец строки назначения, а также количество символов, оставшихся неиспользуемыми в этой строке. Флаги также могут передаваться в функцию для дополнительного управления.
StringCchCatEx является заменой следующих функций:
Синтаксис
STRSAFEAPI StringCchCatExA(
[in, out] STRSAFE_LPSTR pszDest,
[in] size_t cchDest,
[in] STRSAFE_LPCSTR pszSrc,
[out, optional] STRSAFE_LPSTR *ppszDestEnd,
[out, optional] size_t *pcchRemaining,
[in] DWORD dwFlags
);
Параметры
[in, out] pszDest
Тип: LPTSTR
Буфер назначения, который содержит строку, которая должна быть сцеплена с pszSrc и которая получит всю результирующую строку. Строка в pszSrc добавляется в конец строки в pszDest.
[in] cchDest
Тип: size_t
Размер буфера назначения в символах. Это значение должно равняться длине pszSrc плюс длина pszDest плюс 1, чтобы учитывать обе строки и завершающий символ NULL. Максимально допустимое количество символов — STRSAFE_MAX_CCH.
[in] pszSrc
Тип: LPCTSTR
Исходная строка, которая должна быть сцеплена с концом pszDest. Эта строка должна заканчиваться null.
[out, optional] ppszDestEnd
Тип: LPTSTR*
Адрес указателя на конец pszDest. Если параметр ppszDestEnd не равен NULL и любые данные добавляются в буфер назначения, это указывает на завершающий символ NULL в конце строки.
[out, optional] pcchRemaining
Тип: size_t*
Количество неиспользуемых символов в pszDest, включая завершающий пустой символ. Если pcchRemaining имеет значение NULL, счетчик не сохраняется и не возвращается.
[in] dwFlags
Тип: DWORD
Одно или несколько из следующих значений.
| Значение | Значение |
|---|---|
|
Если функция выполняется успешно, низкий байт dwFlags (0) используется для заполнения неинициализированной части pszDest после завершающего символа NULL. |
|
Обрабатываются пустые строки указателей NULL (TEXT("")). Этот флаг полезен для эмуляции таких функций, как lstrcpy. |
|
Если функция завершается ошибкой, для заполнения всего буфера pszDest используется низкий байт dwFlags (0), а буфер завершается значением NULL. В случае сбоя STRSAFE_E_INSUFFICIENT_BUFFER любая ранее существующая или усеченная строка в буфере назначения перезаписывается. |
|
Если функция завершается сбоем, pszDest получает пустую строку (TEXT("")). В случае сбоя STRSAFE_E_INSUFFICIENT_BUFFER любая ранее существующая или усеченная строка в буфере назначения перезаписывается. |
|
Если функция завершается сбоем, pszDest нетронуто. К исходному содержимому ничего не добавляется. |
Возвращаемое значение
Тип: HRESULT
Эта функция может возвращать одно из следующих значений. Настоятельно рекомендуется использовать макросы SUCCEEDED и FAILED для проверки возвращаемого значения этой функции.
| Код возврата | Описание |
|---|---|
|
Исходные данные присутствовали, строки были полностью сцеплены без усечения, а результирующий буфер назначения завершается null. |
|
Значение в cchDest равно 0 или больше STRSAFE_MAX_CCH либо целевой буфер уже заполнен. |
|
Операция копирования завершилась сбоем из-за нехватки места в буфере. В зависимости от значения dwFlags, буфер назначения может содержать усеченную версию предполагаемого результата, завершаемую null. В ситуациях, когда усечение является приемлемым, это не обязательно может рассматриваться как условие сбоя. |
Обратите внимание, что эта функция возвращает значение HRESULT , в отличие от функций, которые она заменяет.
Комментарии
StringCchCatEx обеспечивает дополнительную обработку для правильной обработки буфера в коде. Плохая обработка буфера связана со многими проблемами безопасности, которые связаны с переполнением буфера. StringCchCatEx всегда завершается со значением NULL и никогда не переполняет допустимый буфер назначения, даже если содержимое исходной строки изменяется во время операции.
Поведение не определено, если строки, на которые указывают pszSrc и pszDest , перекрываются.
Ни pszSrc, ни pszDest не должны иметь значение NULL , если не указан флаг STRSAFE_IGNORE_NULLS . В этом случае оба значения могут иметь значение NULL. Однако ошибка из-за нехватки места может по-прежнему возвращаться, даже если значения NULL игнорируются.
StringCchCatEx можно использовать в его универсальной форме или в более конкретных формах. Тип данных строки определяет форму этой функции, которую следует использовать, как показано в следующей таблице.
| Тип данных String | Строковый литерал | Функция |
|---|---|---|
| char | Строка | StringCchCatExA |
| TCHAR | TEXT("string") | StringCchCatEx |
| WCHAR | L"string" | StringCchCatExW |
Примечание
Заголовок strsafe.h определяет StringCchCatEx в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОД. Использование псевдонима, не зависящий от кодирования, с кодом, который не является нейтральным для кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или времени выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.
Требования
| Требование | Значение |
|---|---|
| Минимальная версия клиента | Windows XP с пакетом обновления 2 (SP2) [классические приложения | Приложения UWP] |
| Минимальная версия сервера | Windows Server 2003 с пакетом обновления 1 (SP1) [классические приложения | Приложения UWP] |
| Целевая платформа | Windows |
| Header | strsafe.h |
См. также раздел
Справочные материалы