8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man9f / stoi.9f
blob74bc07d6bc16a89aaf4ac3b84fa821d24b3595be
1 '\" te
2 .\" Copyright (c) 2006, Sun Microsystems, Inc.
3 .\" 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.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" 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 the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH STOI 9F "Jan 16, 2006"
7 .SH NAME
8 stoi, numtos \- convert between an integer and a decimal string
9 .SH SYNOPSIS
10 .LP
11 .nf
12 #include <sys/ddi.h>
14 \fBint\fR \fBstoi\fR(\fBchar\fR \fI**str\fR);
15 .fi
17 .LP
18 .nf
19 \fBvoid\fR \fBnumtos\fR(\fBunsigned long\fR \fInum\fR, \fBchar *\fR\fIs\fR);
20 .fi
22 .SH INTERFACE LEVEL
23 .sp
24 .LP
25 Solaris DDI specific (Solaris DDI).
26 .SH PARAMETERS
27 .sp
28 .ne 2
29 .na
30 \fB\fIstr\fR\fR
31 .ad
32 .RS 7n
33 Pointer to a character string to be converted.
34 .RE
36 .sp
37 .ne 2
38 .na
39 \fB\fInum\fR\fR
40 .ad
41 .RS 7n
42 Decimal number to be converted to a character string.
43 .RE
45 .sp
46 .ne 2
47 .na
48 \fB\fIs\fR\fR
49 .ad
50 .RS 7n
51 Character buffer to hold converted decimal number.
52 .RE
54 .SH DESCRIPTION
55 .SS "\fBstoi()\fR"
56 .sp
57 .LP
58 The \fBstoi()\fR function returns the integer value of a string of decimal
59 numeric characters beginning at \fI**str\fR. No overflow checking is done.
60 \fI*str\fR is updated to point at the last character examined.
61 .SS "\fBnumtos()\fR"
62 .sp
63 .LP
64 The \fBnumtos()\fR function converts a \fBlong\fR into a null-terminated
65 character string. No bounds checking is done. The caller must ensure there is
66 enough space to hold the result.
67 .SH RETURN VALUES
68 .sp
69 .LP
70 The \fBstoi()\fR function returns the integer value of the string \fIstr\fR.
71 .SH CONTEXT
72 .sp
73 .LP
74 The \fBstoi()\fR function can be called from user, interrupt, or kernel
75 context.
76 .SH SEE ALSO
77 .sp
78 .LP
79 \fIWriting Device Drivers\fR
80 .SH NOTES
81 .sp
82 .LP
83 The \fBstoi()\fR function handles only positive integers; it does not handle
84 leading minus signs.