Merge commit '9276b3991ba20d5a5660887ba81b0bc7bed25a0c'
[unleashed.git] / share / man / man9f / max.9f
bloba7f1343fbbd2d93c13d6d442a30b75adb50b14be
1 '\" te
2 .\"  Copyright 1989 AT&T
3 .\"  Copyright (c) 2006, Sun Microsystems, Inc.,  All Rights Reserved
4 .\" 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.
5 .\" 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.
6 .\" 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]
7 .TH MAX 9F "Jan 16, 2006"
8 .SH NAME
9 max \- return the larger of two integers
10 .SH SYNOPSIS
11 .LP
12 .nf
13 #include <sys/ddi.h>
17 \fBint\fR \fBmax\fR(\fBint\fR \fIint1\fR, \fBint\fR \fIint2\fR);
18 .fi
20 .SH INTERFACE LEVEL
21 .sp
22 .LP
23 Architecture independent level 1 (DDI/DKI).
24 .SH PARAMETERS
25 .sp
26 .ne 2
27 .na
28 \fB\fIint1\fR\fR
29 .ad
30 .RS 8n
31 The first integer.
32 .RE
34 .sp
35 .ne 2
36 .na
37 \fB\fIint2\fR\fR
38 .ad
39 .RS 8n
40 The second integer.
41 .RE
43 .SH DESCRIPTION
44 .sp
45 .LP
46 The \fBmax()\fR function compares two signed integers and returns the larger of
47 the two.
48 .SH RETURN VALUES
49 .sp
50 .LP
51 The larger of the two numbers.
52 .SH CONTEXT
53 .sp
54 .LP
55 The \fBmax()\fR function can be called from user, interrupt, or kernel context.
56 .SH SEE ALSO
57 .sp
58 .LP
59 \fBmin\fR(9F)
60 .sp
61 .LP
62 \fIWriting Device Drivers\fR