blob: 69f6df238e7b135c378b0ce8fc4c664322f1f491 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
/*
* @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* ====================================================================== */
/**
* @file VP_GetEnv.h
* @brief \~english Get vehicle parameter environment variable API header file
*/
/* ====================================================================== */
#ifndef VEHICLE_PARAMETER_LIBRARY_LIBRARY_INCLUDE_OTHER_SERVICE_VP_GETENV_H_
#define VEHICLE_PARAMETER_LIBRARY_LIBRARY_INCLUDE_OTHER_SERVICE_VP_GETENV_H_
/** @addtogroup BaseSystem
* @{
*/
/** @addtogroup other_service
* @ingroup BaseSystem
* @{
*/
/** @addtogroup vehicle_parameter_library
* @ingroup other_service
* @{
*/
#include <other_service/env_ext.h>
/**
* @~english the max length of vehicle parameter environment viarable
*/
#define VP_MAX_LENGTH 128
/**
* @~english definition of parameter environment viarable such as destination
* destination diff
*/
#define VEHICLEPARAMETERLIBRARY_AREA "VEHICLEPARAMETERLIBRARY_AREA"
/**
* @~english brand diff
*/
#define VEHICLEPARAMETERLIBRARY_BRAND "VEHICLEPARAMETERLIBRARY_BRAND"
/**
* @~english definition of _CWORD31_ vehicle parameter environment viarable
*/
#include <other_service/env_vehicle.h>
/**
* @~english definition of vehicle parameter environment viarable
*/
#include <other_service/env_vehicleparameterlibrary.h>
/**
* @~english definition of Serial vehicle parameter environment viarable
*/
#include <other_service/env_vehicleparameterlibrary_serial.h>
/* Function prototype declaration */
#ifdef __cplusplus
extern "C" {
#endif
////////////////////////////////////////////////////////////////////////////////
/// \ingroup VP_GetEnv
/// \~english @par Brief
/// VP_GetEnv
/// \~english @param [in] pEnvStr
/// The pointer of environment variable name string
/// \~english @param [out] pEnvBuff
/// The head address of saving environment variable value
/// \~english @retval None
/// \~english @par Prerequisite
/// None
/// \~english @par Change of internal state
/// None
/// \~english @par Conditions of processing failure
/// None
/// \~english @par Classification
/// Public
/// \~english @par Type
/// Sync Only
/// \~english @par Detail
/// - To get the environment variable value by the environment variable name,
/// and save it in pEnvBuff.
/// - When environment variable name is NULL or an undefined value,
/// a blank string shall be saved in pEnvBuff.
/// \~english @see None
////////////////////////////////////////////////////////////////////////////////
void VP_GetEnv(const char *pEnvStr, char *pEnvBuff);
#ifdef __cplusplus
}
#endif
/** @}*/ // end of vehicle_parameter_library
/** @}*/ // end of other_service
/** @}*/ // end of BaseSystem
#endif // VEHICLE_PARAMETER_LIBRARY_LIBRARY_INCLUDE_OTHER_SERVICE_VP_GETENV_H_
|
