service/other/posix_based_os001_legacy_library/library/include/other_service/strlcat.h

   1 /*
   2  * @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef OTHERSERVICE_POSIXBASEDOS001LEGACYLIBRARY_POSIXBASEDOS001_STRLCAT_H_  // NOLINT(build/header_guard)
  18 #define OTHERSERVICE_POSIXBASEDOS001LEGACYLIBRARY_POSIXBASEDOS001_STRLCAT_H_  // NOLINT(build/header_guard)
  19
  20 #include <strings.h>
  21
  22 #ifdef __cplusplus
  23 extern "C" {
  24 #endif
  25 /**
  26  * @file strlcat.h
  27  * @brief \~english This file provides strlcat API to concatenate strings
  28  */
  29
  30 /** @addtogroup BaseSystem
  31  *  @{
  32  */
  33 /** @addtogroup other_service
  34  *  @ingroup BaseSystem
  35  *  @{
  36  */
  37 /** @addtogroup posix_based_os001_legacy_library
  38  *  @ingroup other_service
  39  *  @{
  40  */
  41
  42 /////////////////////////////////////////////////////////////////////////////////////
  43 /// \ingroup strlcat
  44 /// \~english @par Brief
  45 ///     Concatenate strings
  46 /// \~english @param [in/out] dst
  47 ///     char * - Destination string
  48 /// \~english @param [in] src
  49 ///     const char * - Concatenated string
  50 /// \~english @param [in] siz
  51 ///     size_t - Size of dst
  52 /// \~english @retval String length after concatenation
  53 /// \~english @par Prerequisite
  54 ///     None
  55 /// \~english @par Change of internal state
  56 ///     None
  57 /// \~english @par Conditions of processing failure
  58 ///     None
  59 /// \~english @par Classification
  60 ///     Public
  61 /// \~english @par Type
  62 ///     Sync
  63 /// \~english @par Detail
  64 ///     Appends src to string dst of size siz (unlike strncat, siz is the full size of dst, not space left).
  65 ///     At most siz-1 characters will be copied. Always NUL terminates (unless siz <= strlen(dst)).
  66 ///     Returns strlen(src) + MIN(siz, strlen(initial dst)). If retval >= siz, truncation occurred.
  67 /// \~english @see None
  68 ////////////////////////////////////////////////////////////////////////////////////
  69 size_t strlcat(char *dst, const char *src, size_t siz);  // NOLINT(readability/nolint)
  70
  71 /** @}*/  // end of posix_based_os001_legacy_library
  72 /** @}*/  // end of other_service
  73 /** @}*/  // end of BaseSystem
  74 #ifdef __cplusplus
  75 }
  76 #endif
  77
  78 #endif  // OTHERSERVICE_POSIXBASEDOS001LEGACYLIBRARY_POSIXBASEDOS001_STRLCAT_H_