usr/src/man/man9f/min.9f

   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 MIN 9F "Jan 16, 2006"
   8 .SH NAME
   9 min \- return the lesser of two integers
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/ddi.h>
  14
  15
  16
  17 \fBint\fR \fBmin\fR(\fBint\fR \fIint1\fR, \fBint\fR \fIint2\fR);
  18 .fi
  19
  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
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIint2\fR\fR
  38 .ad
  39 .RS 8n
  40 The second integer.
  41 .RE
  42
  43 .SH DESCRIPTION
  44 .sp
  45 .LP
  46 The \fBmin()\fR function compares two signed integers and returns the lesser of
  47 the two.
  48 .SH RETURN VALUES
  49 .sp
  50 .LP
  51 The lesser of the two integers.
  52 .SH CONTEXT
  53 .sp
  54 .LP
  55 The \fBmin()\fR function can be called from user, interrupt, or kernel context.
  56 .SH SEE ALSO
  57 .sp
  58 .LP
  59 \fBmax\fR(9F)
  60 .sp
  61 .LP
  62 \fIWriting Device Drivers\fR