home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / src / Tools / vtcl / doc / PrintDbl.3 < prev    next >
Encoding:
Text File  |  1995-07-10  |  2.7 KB  |  66 lines
  1. '\"
  2. '\" Copyright (c) 1989-1993 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/tcl/man/RCS/PrintDbl.3,v 1.2 93/06/05 15:32:01 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. '\"----------------------------------------------------------------------------
  24. '\"    @(#) PrintDbl.3 26.1 93/10/22 SCOINC
  25. '\"
  26. '\"     Copyright (C) The Santa Cruz Operation, 1992-1993.
  27. '\"     This Module contains Proprietary Information of
  28. '\"    The Santa Cruz Operation, and should be treated as Confidential.
  29. '\"----------------------------------------------------------------------------
  30. .so ../man.macros
  31. .HS Tcl_PrintDouble tclc 7.0
  32. .BS
  33. .SH NAME
  34. Tcl_PrintDouble \- Convert floating value to string
  35. .SH SYNOPSIS
  36. .nf
  37. \fB#include <tcl.h>\fR
  38. .sp
  39. \fBTcl_PrintDouble\fR(\fIinterp, value, dst\fR)
  40. .SH ARGUMENTS
  41. .AS Tcl_Interp *interp
  42. .AP Tcl_Interp *interp in
  43. Interpreter that controls the conversion.
  44. .AP double value in
  45. Floating-point value to be converted.
  46. .AP char *dst out
  47. Where to store string representing \fIvalue\fR.  Must have at
  48. least TCL_DOUBLE_SPACE characters of storage.
  49. .BE
  50.  
  51. .SH DESCRIPTION
  52. .PP
  53. \fBTcl_PrintDouble\fR generates a string that represents the value
  54. of \fIvalue\fR and stores it in memory at the location given by
  55. \fIdst\fR.  It uses %g format to generate the string, with two
  56. special twists.  First, the string is guaranteed to contain either
  57. a ``.'' or an ``e'' so that it doesn't look like an integer (where
  58. %g would generate an integer with no decimal point, \fBTcl_PrintDouble\fR
  59. adds ``.0'').  Second, the number of significant digits printed at
  60. \fIdst\fR is controlled by the \fBtcl_precision\fR variable in
  61. \fIinterp\fR;  if \fBtcl_precision\fR is undefined then 6 significant
  62. digits are printed.
  63.  
  64. .SH KEYWORDS
  65. conversion, double-precision, floating-point, string
  66.