share/man/man3c/wcstoimax.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  44 .\" Portions Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
  45 .\"
  46 .TH WCSTOIMAX 3C "Dec 1, 2003"
  47 .SH NAME
  48 wcstoimax, wcstoumax \- convert wide-character string to integer type
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <stddef.h>
  53 #include <inttypes.h>
  54
  55 \fBintmax_t\fR \fBwcstoimax\fR(\fBconst wchar_t *restrict\fR \fInptr\fR,
  56      \fBwchar_t **restrict\fR \fIendptr\fR, \fBint\fR \fIbase\fR);
  57 .fi
  58
  59 .LP
  60 .nf
  61 \fBuintmax_t\fR \fBwcstoumax\fR(\fBconst wchar_t *restrict\fR \fInptr\fR,
  62      \fBwchar_t **restrict\fR \fIendptr\fR, \fBint\fR \fIbase\fR);
  63 .fi
  64
  65 .SH DESCRIPTION
  66 .sp
  67 .LP
  68 These functions are equivalent to the \fBwcstol\fR(3C), \fBwcstoll\fR(3C),
  69 \fBwcstoul\fR(3C), and \fBwcstoull\fR(3C) functions, respectively, except that
  70 the initial portion of the wide string is converted to \fBintmax_t\fR and
  71 \fBuintmax_t\fR representation, respectively.
  72 .SH RETURN VALUES
  73 .sp
  74 .LP
  75 These functions return the converted value, if any. If no conversion could be
  76 performed, 0 is returned. If the correct value is outside the range of
  77 representable values, {\fBINTMAX_MAX\fR}, {\fBINTMAX_MIN\fR}, or
  78 {\fBUINTMAX_MAX\fR} is returned (according to the return type and sign of the
  79 value), and \fBerrno\fR is set to \fBERANGE\fR.
  80 .SH ERRORS
  81 .sp
  82 .LP
  83 These functions will fail if:
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fBEINVAL\fR\fR
  88 .ad
  89 .RS 10n
  90 The value of \fIbase\fR is not supported.
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fBERANGE\fR\fR
  97 .ad
  98 .RS 10n
  99 The value to be returned is not representable.
 100 .RE
 101
 102 .sp
 103 .LP
 104 These functions may fail if:
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fBEINVAL\fR\fR
 109 .ad
 110 .RS 10n
 111 No conversion could be performed.
 112 .RE
 113
 114 .SH ATTRIBUTES
 115 .sp
 116 .LP
 117 See \fBattributes\fR(5) for descriptions of the following attributes:
 118 .sp
 119
 120 .sp
 121 .TS
 122 box;
 123 c | c
 124 l | l .
 125 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 126 _
 127 Interface Stability     Standard
 128 _
 129 MT-Level        MT-Safe
 130 .TE
 131
 132 .SH SEE ALSO
 133 .sp
 134 .LP
 135 \fBwcstol\fR(3C), \fBwcstoul\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)