user_namespaces.7: Add an example program
[man-pages.git] / man3 / ecvt_r.3
blobd0fab3221167b4fa94a1413efd9dc547c4b574f4
1 .\" Copyright (C) 2002 Andries Brouwer <aeb@cwi.nl>
2 .\"
3 .\" %%%LICENSE_START(VERBATIM)
4 .\" Permission is granted to make and distribute verbatim copies of this
5 .\" manual provided the copyright notice and this permission notice are
6 .\" preserved on all copies.
7 .\"
8 .\" Permission is granted to copy and distribute modified versions of this
9 .\" manual under the conditions for verbatim copying, provided that the
10 .\" entire resulting derived work is distributed under the terms of a
11 .\" permission notice identical to this one.
12 .\"
13 .\" Since the Linux kernel and libraries are constantly changing, this
14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
15 .\" responsibility for errors or omissions, or for damages resulting from
16 .\" the use of the information contained herein.  The author(s) may not
17 .\" have taken the same level of care in the production of this manual,
18 .\" which is licensed free of charge, as they might when working
19 .\" professionally.
20 .\"
21 .\" Formatted or processed versions of this manual, if unaccompanied by
22 .\" the source, must acknowledge the copyright and authors of this work.
23 .\" %%%LICENSE_END
24 .\"
25 .\" This replaces an earlier man page written by Walter Harms
26 .\" <walter.harms@informatik.uni-oldenburg.de>.
27 .\"
28 .\" Corrected return types; from Fabian; 2004-10-05
29 .\"
30 .TH ECVT_R 3  2007-07-26 "GNU" "Linux Programmer's Manual"
31 .SH NAME
32 ecvt_r, fcvt_r, qecvt_r, qfcvt_r \- convert a floating-point number to a string
33 .SH SYNOPSIS
34 .nf
35 .B #include <stdlib.h>
36 .sp
37 .BI "int ecvt_r(double " number ", int " ndigits ", int *" decpt ,
38 .BI "           int *" sign ", char *" buf ", size_t " len );
39 .sp
40 .BI "int fcvt_r(double " number ", int " ndigits ", int *" decpt ,
41 .BI "           int *" sign ", char *" buf ", size_t " len );
42 .sp
43 .BI "int qecvt_r(long double " number ", int " ndigits ", int *" decpt ,
44 .BI "           int *" sign ", char *" buf ", size_t " len );
45 .sp
46 .BI "int qfcvt_r(long double " number ", int " ndigits ", int *" decpt ,
47 .BI "           int *" sign ", char *" buf ", size_t " len );
48 .fi
49 .sp
50 .in -4n
51 Feature Test Macro Requirements for glibc (see
52 .BR feature_test_macros (7)):
53 .in
54 .sp
55 .ad l
56 .BR ecvt_r (),
57 .BR fcvt_r (),
58 .BR qecvt_r (),
59 .BR qfcvt_r ():
60 .RS 4
61 _SVID_SOURCE || _BSD_SOURCE || _XOPEN_SOURCE\ >=\ 500
62 .RE
63 .ad b
64 .SH DESCRIPTION
65 The functions
66 .BR ecvt_r (),
67 .BR fcvt_r (),
68 .BR qecvt_r (),
69 and
70 .BR qfcvt_r ()
71 are identical to
72 .BR ecvt (3),
73 .BR fcvt (3),
74 .BR qecvt (3),
75 and
76 .BR qfcvt (3),
77 respectively, except that they do not return their result in a static
78 buffer, but instead use the supplied
79 .I buf
80 of size
81 .IR len .
82 See
83 .BR ecvt (3)
84 and
85 .BR qecvt (3).
86 .SH RETURN VALUE
87 These functions return 0 on success, and \-1 otherwise.
88 .SH CONFORMING TO
89 These functions are GNU extensions.
90 .SH NOTES
91 These functions are obsolete.
92 Instead,
93 .BR sprintf (3)
94 is recommended.
95 .SH SEE ALSO
96 .BR ecvt (3),
97 .BR qecvt (3),
98 .BR sprintf (3)