rcutils
master
C API providing common utilities and data structures.
include
rcutils
env.h
Go to the documentation of this file.
1
// Copyright 2020 Open Source Robotics Foundation, Inc.
2
//
3
// Licensed under the Apache License, Version 2.0 (the "License");
4
// you may not use this file except in compliance with the License.
5
// You may obtain a copy of the License at
6
//
7
// http://www.apache.org/licenses/LICENSE-2.0
8
//
9
// Unless required by applicable law or agreed to in writing, software
10
// distributed under the License is distributed on an "AS IS" BASIS,
11
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
// See the License for the specific language governing permissions and
13
// limitations under the License.
14
16
17
#ifndef RCUTILS__ENV_H_
18
#define RCUTILS__ENV_H_
19
20
#ifdef __cplusplus
21
extern
"C"
22
{
23
#endif
24
25
#include <stdbool.h>
26
27
#include "
rcutils/macros.h
"
28
#include "
rcutils/visibility_control.h
"
29
30
// TODO(cottsay): Deprecate get_env.h and eventually merge it here
31
#include "
rcutils/get_env.h
"
32
34
56
RCUTILS_PUBLIC
57
RCUTILS_WARN_UNUSED
58
bool
59
rcutils_set_env
(
const
char
* env_name,
const
char
* env_value);
60
61
#ifdef __cplusplus
62
}
63
#endif
64
65
#endif // RCUTILS__ENV_H_
get_env.h
macros.h
RCUTILS_WARN_UNUSED
#define RCUTILS_WARN_UNUSED
A macro to make the compiler warn when the return value of a function is not used.
Definition:
macros.h:27
visibility_control.h
RCUTILS_PUBLIC
#define RCUTILS_PUBLIC
Definition:
visibility_control.h:23
rcutils_set_env
bool rcutils_set_env(const char *env_name, const char *env_value)
Set or un-set a process-scoped environment variable.
Generated by
1.8.17