2 * @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 /* ====================================================================== */
20 * @brief \~english Get vehicle parameter environment variable API header file
22 /* ====================================================================== */
24 #ifndef VEHICLE_PARAMETER_LIBRARY_LIBRARY_INCLUDE_OTHER_SERVICE_VP_GETENV_H_
25 #define VEHICLE_PARAMETER_LIBRARY_LIBRARY_INCLUDE_OTHER_SERVICE_VP_GETENV_H_
27 /** @addtogroup BaseSystem
30 /** @addtogroup other_service
34 /** @addtogroup vehicle_parameter_library
35 * @ingroup other_service
38 #include <other_service/env_ext.h>
41 * @~english the max length of vehicle parameter environment viarable
44 #define VP_MAX_LENGTH 128
47 * @~english definition of parameter environment viarable such as destination
51 #define VEHICLEPARAMETERLIBRARY_AREA "VEHICLEPARAMETERLIBRARY_AREA"
54 * @~english brand diff
56 #define VEHICLEPARAMETERLIBRARY_BRAND "VEHICLEPARAMETERLIBRARY_BRAND"
59 * @~english definition of _CWORD31_ vehicle parameter environment viarable
61 #include <other_service/env_vehicle.h>
64 * @~english definition of vehicle parameter environment viarable
66 #include <other_service/env_vehicleparameterlibrary.h>
69 * @~english definition of Serial vehicle parameter environment viarable
71 #include <other_service/env_vehicleparameterlibrary_serial.h>
73 /* Function prototype declaration */
78 ////////////////////////////////////////////////////////////////////////////////
79 /// \ingroup VP_GetEnv
80 /// \~english @par Brief
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
89 /// \~english @par Change of internal state
91 /// \~english @par Conditions of processing failure
93 /// \~english @par Classification
95 /// \~english @par Type
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);
110 /** @}*/ // end of vehicle_parameter_library
111 /** @}*/ // end of other_service
112 /** @}*/ // end of BaseSystem
114 #endif // VEHICLE_PARAMETER_LIBRARY_LIBRARY_INCLUDE_OTHER_SERVICE_VP_GETENV_H_