video_in_hal/otherservice/vehicle_parameter_library/library/include/other_service/VP_GetEnv.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 /* ====================================================================== */
  18 /**
  19  * @file VP_GetEnv.h
  20  * @brief \~english Get vehicle parameter environment variable API header file
  21  */
  22 /* ====================================================================== */
  23
  24 #ifndef VEHICLE_PARAMETER_LIBRARY_LIBRARY_INCLUDE_OTHER_SERVICE_VP_GETENV_H_
  25 #define VEHICLE_PARAMETER_LIBRARY_LIBRARY_INCLUDE_OTHER_SERVICE_VP_GETENV_H_
  26
  27 /** @addtogroup BaseSystem
  28  *  @{
  29  */
  30 /** @addtogroup other_service
  31  *  @ingroup BaseSystem
  32  *  @{
  33  */
  34 /** @addtogroup vehicle_parameter_library
  35  *  @ingroup other_service
  36  *  @{
  37  */
  38 #include <other_service/env_ext.h>
  39
  40 /**
  41 * @~english the max length of vehicle parameter environment viarable
  42 */
  43
  44 #define     VP_MAX_LENGTH   128
  45
  46 /**
  47 * @~english definition of parameter environment viarable such as destination
  48 *           destination diff
  49 */
  50
  51 #define     VEHICLEPARAMETERLIBRARY_AREA       "VEHICLEPARAMETERLIBRARY_AREA"
  52
  53 /**
  54 * @~english brand diff
  55 */
  56 #define     VEHICLEPARAMETERLIBRARY_BRAND      "VEHICLEPARAMETERLIBRARY_BRAND"
  57
  58 /**
  59 * @~english  definition of _CWORD31_ vehicle parameter environment viarable
  60 */
  61 #include <other_service/env_vehicle.h>
  62
  63 /**
  64 * @~english definition of vehicle parameter environment viarable
  65 */
  66 #include <other_service/env_vehicleparameterlibrary.h>
  67
  68 /**
  69 * @~english definition of Serial vehicle parameter environment viarable
  70 */
  71 #include <other_service/env_vehicleparameterlibrary_serial.h>
  72
  73 /* Function prototype declaration */
  74 #ifdef __cplusplus
  75 extern "C" {
  76 #endif
  77
  78 ////////////////////////////////////////////////////////////////////////////////
  79 /// \ingroup VP_GetEnv
  80 /// \~english @par Brief
  81 ///         VP_GetEnv
  82 /// \~english @param [in] pEnvStr
  83 ///         The pointer of environment variable name string
  84 /// \~english @param [out] pEnvBuff
  85 ///         The head address of saving environment variable value
  86 /// \~english @retval None
  87 /// \~english @par Prerequisite
  88 ///         None
  89 /// \~english @par Change of internal state
  90 ///         None
  91 /// \~english @par Conditions of processing failure
  92 ///         None
  93 /// \~english @par Classification
  94 ///         Public
  95 /// \~english @par Type
  96 ///         Sync Only
  97 /// \~english @par Detail
  98 ///         - To get the environment variable value by the environment variable name,
  99 ///           and save it in pEnvBuff.
 100 ///         - When environment variable name is NULL or an undefined value,
 101 ///           a blank string shall be saved in pEnvBuff.
 102 /// \~english @see None
 103 ////////////////////////////////////////////////////////////////////////////////
 104 void VP_GetEnv(const char *pEnvStr, char *pEnvBuff);
 105
 106 #ifdef __cplusplus
 107 }
 108 #endif
 109
 110 /** @}*/  // end of vehicle_parameter_library
 111 /** @}*/  // end of other_service
 112 /** @}*/  // end of BaseSystem
 113
 114 #endif  // VEHICLE_PARAMETER_LIBRARY_LIBRARY_INCLUDE_OTHER_SERVICE_VP_GETENV_H_