man3/gcvt.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   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 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified Sat Jul 24 19:32:25 1993 by Rik Faith (faith@cs.unc.edu)
  30 .TH GCVT 3 2021-03-22 "" "Linux Programmer's Manual"
  31 .SH NAME
  32 gcvt \- convert a floating-point number to a string
  33 .SH SYNOPSIS
  34 .nf
  35 .B #include <stdlib.h>
  36 .PP
  37 .BI "char *gcvt(double " number ", int " ndigit ", char *" buf );
  38 .fi
  39 .PP
  40 .RS -4
  41 Feature Test Macro Requirements for glibc (see
  42 .BR feature_test_macros (7)):
  43 .RE
  44 .PP
  45 .BR gcvt ():
  46 .nf
  47     Since glibc 2.17
  48         (_XOPEN_SOURCE >= 500 && ! (_POSIX_C_SOURCE >= 200809L))
  49             || /* Glibc >= 2.20 */ _DEFAULT_SOURCE
  50             || /* Glibc <= 2.19 */ _SVID_SOURCE
  51     Glibc versions 2.12 to 2.16:
  52         (_XOPEN_SOURCE >= 500 && ! (_POSIX_C_SOURCE >= 200112L))
  53             || _SVID_SOURCE
  54     Before glibc 2.12:
  55         _SVID_SOURCE || _XOPEN_SOURCE >= 500
  56 .\"        || _XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED
  57 .fi
  58 .SH DESCRIPTION
  59 The
  60 .BR gcvt ()
  61 function converts \fInumber\fP to a minimal length null-terminated
  62 ASCII string and stores the result in \fIbuf\fP.
  63 It produces \fIndigit\fP significant digits in either
  64 .BR printf (3)
  65 F format or E format.
  66 .SH RETURN VALUE
  67 The
  68 .BR gcvt ()
  69 function returns
  70 \fIbuf\fP.
  71 .SH ATTRIBUTES
  72 For an explanation of the terms used in this section, see
  73 .BR attributes (7).
  74 .ad l
  75 .nh
  76 .TS
  77 allbox;
  78 lbx lb lb
  79 l l l.
  80 Interface       Attribute       Value
  81 T{
  82 .BR gcvt ()
  83 T}      Thread safety   MT-Safe
  84 .TE
  85 .hy
  86 .ad
  87 .sp 1
  88 .SH CONFORMING TO
  89 Marked as LEGACY in POSIX.1-2001.
  90 POSIX.1-2008 removes the specification of
  91 .BR gcvt (),
  92 recommending the use of
  93 .BR sprintf (3)
  94 instead (though
  95 .BR snprintf (3)
  96 may be preferable).
  97 .SH SEE ALSO
  98 .BR ecvt (3),
  99 .BR fcvt (3),
 100 .BR sprintf (3)