]>
Commit | Line | Data |
---|---|---|
fea681da MK |
1 | .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk) |
2 | .\" | |
3 | .\" Permission is granted to make and distribute verbatim copies of this | |
4 | .\" manual provided the copyright notice and this permission notice are | |
5 | .\" preserved on all copies. | |
6 | .\" | |
7 | .\" Permission is granted to copy and distribute modified versions of this | |
8 | .\" manual under the conditions for verbatim copying, provided that the | |
9 | .\" entire resulting derived work is distributed under the terms of a | |
10 | .\" permission notice identical to this one. | |
c13182ef | 11 | .\" |
fea681da MK |
12 | .\" Since the Linux kernel and libraries are constantly changing, this |
13 | .\" manual page may be incorrect or out-of-date. The author(s) assume no | |
14 | .\" responsibility for errors or omissions, or for damages resulting from | |
15 | .\" the use of the information contained herein. The author(s) may not | |
16 | .\" have taken the same level of care in the production of this manual, | |
17 | .\" which is licensed free of charge, as they might when working | |
18 | .\" professionally. | |
c13182ef | 19 | .\" |
fea681da MK |
20 | .\" Formatted or processed versions of this manual, if unaccompanied by |
21 | .\" the source, must acknowledge the copyright and authors of this work. | |
22 | .\" | |
23 | .\" References consulted: | |
24 | .\" Linux libc source code | |
25 | .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) | |
26 | .\" 386BSD man pages | |
27 | .\" Modified Sat Jul 24 19:40:39 1993 by Rik Faith (faith@cs.unc.edu) | |
28 | .\" Modified Fri Jun 25 12:10:47 1999 by Andries Brouwer (aeb@cwi.nl) | |
29 | .\" | |
30 | .TH ECVT 3 1999-06-25 "" "Linux Programmer's Manual" | |
31 | .SH NAME | |
32 | ecvt, fcvt \- convert a floating-point number to a string | |
33 | .SH SYNOPSIS | |
34 | .B #include <stdlib.h> | |
35 | .sp | |
36 | .BI "char *ecvt(double " number ", int " ndigits ", int *" decpt , | |
37 | .BI "int *" sign ); | |
38 | .sp | |
39 | .BI "char *fcvt(double " number ", int " ndigits ", int *" decpt , | |
40 | .BI "int *" sign ); | |
41 | .SH DESCRIPTION | |
63aa9df0 | 42 | The \fBecvt\fP() function converts \fInumber\fP to a null-terminated |
fea681da MK |
43 | string of \fIndigits\fP digits (where \fIndigits\fP is reduced to an |
44 | system-specific limit determined by the precision of a double), | |
c13182ef MK |
45 | and returns a pointer to the string. |
46 | The high-order digit is non-zero, unless | |
fea681da | 47 | .I number |
c13182ef MK |
48 | is zero. |
49 | The low order digit is rounded. | |
fea681da MK |
50 | The string itself does not contain a decimal point; however, |
51 | the position of the decimal point relative to the start of the string | |
c13182ef MK |
52 | is stored in *\fIdecpt\fP. |
53 | A negative value for *\fIdecpt\fP means that | |
54 | the decimal point is to the left of the start of the string. | |
55 | If the sign of | |
fea681da | 56 | \fInumber\fP is negative, *\fIsign\fP is set to a non-zero value, otherwise |
c13182ef MK |
57 | it's set to 0. |
58 | If | |
fea681da MK |
59 | .I number |
60 | is zero, it is unspecified whether *\fIdecpt\fP is 0 or 1. | |
61 | .PP | |
63aa9df0 | 62 | The \fBfcvt\fP() function is identical to \fBecvt\fP(), except that |
fea681da MK |
63 | \fIndigits\fP specifies the number of digits after the decimal point. |
64 | .SH "RETURN VALUE" | |
c13182ef | 65 | Both the \fBecvt\fP() and \fBfcvt\fP() functions return a pointer to a |
fea681da | 66 | static string containing the ASCII representation of \fInumber\fP. |
63aa9df0 MK |
67 | The static string is overwritten by each call to \fBecvt\fP() or |
68 | \fBfcvt\fP(). | |
fea681da | 69 | .SH NOTES |
c13182ef MK |
70 | These functions are obsolete. |
71 | Instead, | |
31e9a9ec | 72 | .BR sprintf () |
fea681da MK |
73 | is recommended. |
74 | Linux libc4 and libc5 specified the type of | |
75 | .I ndigits | |
76 | as | |
77 | .BR size_t . | |
78 | Not all locales use a point as the radix character (`decimal point'). | |
79 | .SH "CONFORMING TO" | |
68e1685c MK |
80 | SVr2; |
81 | marked as LEGACY in POSIX.1-2001. | |
fea681da MK |
82 | .SH "SEE ALSO" |
83 | .BR ecvt_r (3), | |
84 | .BR gcvt (3), | |
85 | .BR qecvt (3), | |
86 | .BR setlocale (3), | |
87 | .BR sprintf (3) |