aboutsummaryrefslogtreecommitdiffstats
path: root/man/zstr.3
blob: 568e32c65e4cac5c268102ac354fe72759ac18a8 (plain) (blame)
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
.TH ZSTR 3 libzahl
.SH NAME
zstr - Create a string representation of a big integer
.SH SYNOPSIS
.nf
#include <zahl.h>

char *zstr(z_t \fIa\fP, char *\fIstr\fP, size_t \fIn\fP);
.fi
.SH DESCRIPTION
.B zstr
writes the integer
.I a
in decimal form into
.IR str .
If
.I str
is is
.BR 0 ,
.B zstr
create a new allocation.
.P
.I n
must be either be zero or a value at least
as great as the length of the resulting string.
If both
.I n
and
.I str
are nonzero,
.I n
must be at least the allocation size of
.I str
minus 1. Proper value for
.I n
can be calculated using
.BR zstr_length (3).
.SH RETURN VALUE
.I str
is returned unless
.I str
is
.BR 0 .
If
.I str
is
.BR 0 ,
the string allocated by the function is returned.
.SH SEE ALSO
.BR zstr_length (3),
.BR zsets (3),
.BR zload (3)