summaryrefslogtreecommitdiff
path: root/docs/man/man3/rtapi_snprintf.3rtapi
blob: f71673794669958494b595bcac8f4c9c80215265 (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
.TH rtapi_snprintf "3rtapi" "2006-10-12" "LinuxCNC Documentation" "RTAPI"
.SH NAME

rtapi_snprintf, rtapi_vsnprintf \- Perform snprintf-like string formatting

.SH SYNTAX
.HP
 int rtapi_snprintf(char *\fIbuf\fR, unsigned long int \fIsize\fR, const char *\fIfmt\fR, \fI...\fR)

.HP
 int rtapi_vsnprintf(char *\fIbuf\fR, unsigned long int \fIsize\fR, const char *\fIfmt\fR, va_list \fIapfB)

.SH  ARGUMENTS
As for \fIsnprintf(3)\fR or \fIvsnprintf(3)\fR.

.SH DESCRIPTION
These functions work like the standard C printf functions, except that a
reduced set of formatting operations are supported.

In particular: formatting of long long values is not supported.  Formatting of
floating-point values is done as though with %A even when other formats like %f
are specified.

.SH REALTIME CONSIDERATIONS
May be called from user, init/cleanup, and realtime code.

.SH RETURN VALUE
The number of characters written to \fIbuf\fR.

.SH SEE ALSO
\fBprintf(3)\fR