share/man/man9f/ddi_strtoll.9f

   1 '\" te
   2 .\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved.
   3 .\" Portions Copyright (c) 2009, Sun Microsystems Inc. All Rights Reserved.
   4 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text
   6 .\" are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical
   7 .\" and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   8 .\"  This notice shall appear on any product containing this material.
   9 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
  10 .\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with
  11 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  12 .TH DDI_STRTOLL 9F "Feb 25, 2009"
  13 .SH NAME
  14 ddi_strtoll, ddi_strtoull \- string conversion functions
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 #include <sys/ddi.h>
  19 #include <sys/sunddi.h>
  20
  21 \fBint\fR \fBddi_strtoll\fR(\fBconst char *\fR\fIstr\fR, \fBchar **\fR\fIendptr\fR, \fBint\fR \fIbase\fR,
  22      \fBlonglong_t *\fR\fIresult\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBint\fR \fBddi_strtoull\fR(\fBconst char *\fR\fIstr\fR, \fBchar **\fR\fIendptr\fR, \fBint\fR \fIbase\fR,
  28      \fBu_longlong_t *\fR\fIresult\fR);
  29 .fi
  30
  31 .SH PARAMETERS
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fIstr\fR\fR
  36 .ad
  37 .RS 10n
  38 pointer to a character string to be converted
  39 .RE
  40
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fIendptr\fR\fR
  45 .ad
  46 .RS 10n
  47 post-conversion final string of unrecognized characters
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fIbase\fR\fR
  54 .ad
  55 .RS 10n
  56 radix used for conversion
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fIresult\fR\fR
  63 .ad
  64 .RS 10n
  65 pointer to variable which contains the converted value
  66 .RE
  67
  68 .SH INTERFACE LEVEL
  69 .sp
  70 .LP
  71 Solaris DDI specific (Solaris DDI)
  72 .SH DESCRIPTION
  73 .sp
  74 .LP
  75 The \fBddi_strtoll()\fR function converts the initial portion of the string
  76 pointed to by \fIstr\fR to a type \fBlonglong_t\fR representation and stores
  77 the converted value in \fIresult\fR.
  78 .sp
  79 .LP
  80 The \fBddi_strtoull()\fR function converts the initial portion of the string
  81 pointed to by \fIstr\fR to a type \fBu_longlong_t\fR representation and stores
  82 the converted value in \fIresult\fR.
  83 .sp
  84 .LP
  85 These functions first decomposes the input string into three parts:
  86 .RS +4
  87 .TP
  88 1.
  89 An initial (possibly empty) sequence of white-space characters (" ", "\et",
  90 "\en", "\er", "\ef")
  91 .RE
  92 .RS +4
  93 .TP
  94 2.
  95 A subject sequence interpreted as an integer represented in some radix
  96 determined by the value of base
  97 .RE
  98 .RS +4
  99 .TP
 100 3.
 101 A final string of one or more unrecognized characters, including the
 102 terminating null byte of the input string.
 103 .RE
 104 .sp
 105 .LP
 106 The \fBddi_strtoll()\fR function then attempts to convert the subject sequence
 107 to an integer and returns the result. The \fBddi_strtoull()\fR function
 108 attempts to convert the subject sequence to an unsigned integer and returns the
 109 result.
 110 .sp
 111 .LP
 112 If the value of base is 0, the expected form of the subject sequence is that of
 113 a decimal constant, octal constant or hexadecimal constant, any of which may be
 114 preceded by a plus ("+") or minus ("-") sign. A decimal constant begins with a
 115 non-zero digit, and consists of a sequence of decimal digits. An octal constant
 116 consists of the prefix 0 optionally followed by a sequence of the digits 0 to 7
 117 only. A hexadecimal constant consists of the prefix 0x or 0X followed by a
 118 sequence of the decimal digits and letters a (or A) to f (or F) with values 10
 119 to 15 respectively.
 120 .sp
 121 .LP
 122 If the value of base is between 2 and 36, the expected form of the subject
 123 sequence is a sequence of letters and digits representing an integer with the
 124 radix specified by base, optionally preceded by a plus or minus sign. The
 125 letters from a (or A) to z (or Z) inclusive are ascribed the values 10 to 35
 126 and only letters whose ascribed values are less than that of base are
 127 permitted. If the value of base is 16, the characters 0x or 0X may optionally
 128 precede the sequence of letters and digits, following the sign if present.
 129 .sp
 130 .LP
 131 The subject sequence is defined as the longest initial subsequence of the input
 132 string, starting with the first non-white-space character that is of the
 133 expected form. The subject sequence contains no characters if the input string
 134 is empty or consists entirely of white-space characters, or if the first
 135 non-white-space character is other than a sign or a permissible letter or
 136 digit.
 137 .sp
 138 .LP
 139 If the subject sequence has the expected form and the value of base is 0, the
 140 sequence of characters starting with the first digit is interpreted as an
 141 integer constant. If the subject sequence has the expected form and the value
 142 of base is between 2 and 36, it is used as the base for conversion, ascribing
 143 to each letter its value as given above. If the subject sequence begins with a
 144 minus sign, the value resulting from the conversion is negated. A pointer to
 145 the final string is stored in the object pointed to by \fIendptr\fR, provided
 146 that \fIendptr\fR is not a null pointer.
 147 .sp
 148 .LP
 149 If the subject sequence is empty or does not have the expected form, no
 150 conversion is performed and the value of \fIstr\fR is stored in the object
 151 pointed to by \fIendptr\fR, provided that \fIendptr\fR is not a null pointer.
 152 .SH RETURN VALUES
 153 .sp
 154 .LP
 155 Upon successful completion, these functions return 0 and store the converted
 156 value in \fIresult\fR. If no conversion is performed due to an invalid base,
 157 these functions return \fBEINVAL\fR and the variable pointed by \fIresult\fR is
 158 not changed.
 159 .SH CONTEXT
 160 .sp
 161 .LP
 162 These functions may be called from user, kernel or interrupt context.
 163 .SH ATTRIBUTES
 164 .sp
 165 .LP
 166 See \fBattributes\fR(5) for descriptions of the following attributes:
 167 .sp
 168
 169 .sp
 170 .TS
 171 box;
 172 c | c
 173 l | l .
 174 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 175 _
 176 Interface Stability     Committed
 177 .TE
 178
 179 .SH SEE ALSO
 180 .sp
 181 .LP
 182 \fIWriting Device Drivers\fR