usr/src/man/man3c/getdtablesize.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 Berkeley software License Agreement specifies the terms and conditions
  28 .\" for redistribution.
  29 .\"
  30 .\"
  31 .\" Copyright (c) 1983 Regents of the University of California.
  32 .\" All rights reserved.
  33 .\" Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
  34 .\" Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved.
  35 .\"
  36 .TH GETDTABLESIZE 3C "Mar 1, 1996"
  37 .SH NAME
  38 getdtablesize \- get the file descriptor table size
  39 .SH SYNOPSIS
  40 .LP
  41 .nf
  42 #include <unistd.h>
  43
  44 \fBint\fR \fBgetdtablesize\fR(\fBvoid\fR);
  45 .fi
  46
  47 .SH DESCRIPTION
  48 .sp
  49 .LP
  50 The \fBgetdtablesize()\fR function is equivalent to \fBgetrlimit\fR(2) with the
  51 \fBRLIMIT_NOFILE\fR option.
  52 .SH RETURN VALUES
  53 .sp
  54 .LP
  55 The \fBgetdtablesize()\fR function returns the current soft limit as if
  56 obtained from a call to \fBgetrlimit()\fR with the \fBRLIMIT_NOFILE\fR option.
  57 .SH ERRORS
  58 .sp
  59 .LP
  60 No errors are defined.
  61 .SH USAGE
  62 .sp
  63 .LP
  64 There is no direct relationship between the value returned by
  65 \fBgetdtablesize()\fR and \fBOPEN_MAX\fR defined in <\fBlimits.h\fR>.
  66 .sp
  67 .LP
  68 Each process has a file descriptor table which is guaranteed to have at least
  69 20 slots.  The entries in the descriptor table are numbered with small integers
  70 starting at 0. The \fBgetdtablesize()\fR function returns the current maximum
  71 size of this table by calling the \fBgetrlimit()\fR function.
  72 .SH SEE ALSO
  73 .sp
  74 .LP
  75 \fBclose\fR(2), \fBgetrlimit\fR(2), \fBopen\fR(2), \fBsetrlimit\fR(2),
  76 \fBselect\fR(3C)