File: fmt_netstring.3

package info (click to toggle)
libowfat 0.34-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,288 kB
  • sloc: ansic: 20,181; makefile: 16
file content (29 lines) | stat: -rw-r--r-- 870 bytes parent folder | download | duplicates (3)
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
.TH fmt_netstring 3
.SH NAME
fmt_netstring \- convert a memory buffer into a netstring
.SH SYNTAX
.B #include <libowfat/fmt.h>

size_t \fBfmt_netstring\fP(char *\fIdest\fR,const char *\fIsource\fR,
                      size_t \fIlen\fR);
.SH DESCRIPTION
fmt_netstring creates a netstring from a raw memory buffer and returns
the length.

fmt_netstring does not append \\0.

If \fIdest\fR equals FMT_LEN (i.e. is zero), fmt_netstring returns the number
of bytes it would have written.
.SH "RETURN VALUE"
fmt_netstring returns the number of bytes written (or that would have
been written, had the destination pointer not pointed to NULL).

If the input buffer is implausibly large, fmt_netstring returns 0
instead.
.SH EXAMPLE
The raw memory buffer "foo" would become the netstring "3:foo,"
.SH SPEC
http://cr.yp.to/proto/netstrings.txt

.SH "SEE ALSO"
scan_netstring(3)