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
|
// Copyright 2017 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__SNPRINTF_H_
#define RCUTILS__SNPRINTF_H_
#ifdef __cplusplus
extern "C"
{
#endif
#include <stdarg.h>
#include <stddef.h>
#include "rcutils/macros.h"
#include "rcutils/visibility_control.h"
/// Format a string.
/**
* This function just wraps snprintf() as defined in C11 in a portable way.
*
* On Windows this defaults to the _TRUNCATE behavior of _snprintf_s(), but
* only returns -1 if errno is not 0.
* Unlike _snprintf_s() which returns -1 when truncation occurs, this function
* behaves like snprintf() (http://en.cppreference.com/w/cpp/io/c/fprintf):
*
* > Number of characters written if successful or negative value if an error
* > occurred.
* > If the resulting string gets truncated due to buf_size limit, function
* > returns the total number of characters (not including the terminating
* > null-byte) which would have been written, if the limit was not imposed.
*
* If `NULL` and `0` are given for buffer and buffer_size respectively, the
* size of the string that would be generated is returned.
* Either snprintf() or _vscprintf() is used to calculate this value.
*
* \see snprintf()
* \see _snprintf_s()
* \return the number of bytes that would have been written given enough space, or
* \return a negative number if there is an error, but unlike _snprintf_s(),
* -1 is not returned if there is truncation.
*/
RCUTILS_PUBLIC
RCUTILS_WARN_UNUSED
int
rcutils_snprintf(char * buffer, size_t buffer_size, const char * format, ...)
/// @cond Doxygen_Suppress
RCUTILS_ATTRIBUTE_PRINTF_FORMAT(3, 4)
/// @endcond
;
/// Format a string with va_list for arguments, see rcutils_snprintf().
RCUTILS_PUBLIC
RCUTILS_WARN_UNUSED
int
rcutils_vsnprintf(char * buffer, size_t buffer_size, const char * format, va_list args);
#ifdef __cplusplus
}
#endif
#endif // RCUTILS__SNPRINTF_H_
|
