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
|
// Copyright 2020 Open Source Robotics Foundation, Inc.
//
// 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
#ifndef RCUTILS__STRERROR_H_
#define RCUTILS__STRERROR_H_
#ifdef __cplusplus
extern "C"
{
#endif
#include "rcutils/visibility_control.h"
/// Retrieve the string corresponding to the last system error.
/**
* This function retrieves the value of errno, and calls the system-specific
* equivalent of `strerror` on it, storing the output in the provided buffer.
* If the error message is longer than the buffer, it will be truncated.
* The memory for the c-string buffer that is passed in must be managed by the
* caller.
*
* This function is thread-safe.
*
* \param[inout] buffer The buffer in which to store the data
* \param[in] buffer_length the maximum length of the buffer
*/
RCUTILS_PUBLIC
void
rcutils_strerror(char * buffer, size_t buffer_length);
#ifdef __cplusplus
}
#endif
#endif // RCUTILS__STRERROR_H_
|
