Поделиться через


Функция StringCchCopyA (strsafe.h)

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

StringCchCopy является заменой следующих функций:

Синтаксис

STRSAFEAPI StringCchCopyA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cchDest,
  [in]  STRSAFE_LPCSTR pszSrc
);

Параметры

[out] pszDest

Тип: LPTSTR

Буфер назначения, который получает скопированную строку.

[in] cchDest

Тип: size_t

Размер буфера назначения в символах. Это значение должно быть равно длине pszSrc плюс 1 для учета скопированной исходной строки и завершающего символа NULL. Максимально допустимое количество символов — STRSAFE_MAX_CCH.

[in] pszSrc

Тип: LPCTSTR

Исходная строка. Эта строка должна заканчиваться null.

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

Тип: HRESULT

Эта функция может возвращать одно из следующих значений. Настоятельно рекомендуется использовать макросы SUCCEEDED и FAILED для проверки возвращаемого значения этой функции.

Код возврата Описание
S_OK
Исходные данные были полностью скопированы без усечения, а результирующий целевой буфер завершается со значением NULL.
STRSAFE_E_INVALID_PARAMETER
Значение в cchDest равно 0 или больше STRSAFE_MAX_CCH.
STRSAFE_E_INSUFFICIENT_BUFFER
Операция копирования завершилась сбоем из-за недостаточного пространства в буфере. Целевой буфер содержит усеченную версию предполагаемого результата, завершаемую null. В ситуациях, когда усечение приемлемо, это не обязательно может рассматриваться как условие сбоя.
 

Обратите внимание, что эта функция возвращает значение HRESULT , в отличие от функций, которые она заменяет.

Комментарии

По сравнению с функциями, которые он заменяет, StringCchCopy обеспечивает дополнительную обработку для правильной обработки буфера в коде. Плохая обработка буфера связана со многими проблемами безопасности, которые связаны с переполнением буфера. StringCchCopy всегда завершается со значением NULL и никогда не переполняет допустимый буфер назначения, даже если содержимое исходной строки изменяется во время операции.

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

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

StringCchCopy можно использовать в универсальной форме или в более конкретных формах. Тип данных строки определяет форму этой функции, которую следует использовать.

Тип данных String Строковый литерал Функция
char Строка StringCchCopyA
TCHAR TEXT("string") StringCchCopy
WCHAR L"string" StringCchCopyW
 

Примечание

Заголовок strsafe.h определяет StringCchCopy в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОД. Сочетание использования псевдонима, не зависящий от кодировки, с кодом, не зависящим от кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования

Требование Значение
Минимальная версия клиента Windows XP с пакетом обновления 2 (SP2) [классические приложения | Приложения UWP]
Минимальная версия сервера Windows Server 2003 с пакетом обновления 1 (SP1) [классические приложения | Приложения UWP]
Целевая платформа Windows
Header strsafe.h

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

Справочные материалы

StringCbCopy

StringCchCopyEx