doc/html/ref/net-common-tcpip-manpages-ioctl.html

   1 <!-- Copyright (C) 2003 Red Hat, Inc.                                -->
   2 <!-- This material may be distributed only subject to the terms      -->
   3 <!-- and conditions set forth in the Open Publication License, v1.0  -->
   4 <!-- or later (the latest version is presently available at          -->
   5 <!-- http://www.opencontent.org/openpub/).                           -->
   6 <!-- Distribution of the work or derivative of the work in any       -->
   7 <!-- standard (paper) book form is prohibited unless prior           -->
   8 <!-- permission is obtained from the copyright holder.               -->
   9 <HTML
  10 ><HEAD
  11 ><TITLE
  12 >ioctl</TITLE
  13 ><meta name="MSSmartTagsPreventParsing" content="TRUE">
  14 <META
  15 NAME="GENERATOR"
  16 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
  17 "><LINK
  18 REL="HOME"
  19 TITLE="eCos Reference Manual"
  20 HREF="ecos-ref.html"><LINK
  21 REL="UP"
  22 TITLE="TCP/IP Library Reference"
  23 HREF="tcpip-library-reference.html"><LINK
  24 REL="PREVIOUS"
  25 TITLE="getsockopt"
  26 HREF="net-common-tcpip-manpages-getsockopt.html"><LINK
  27 REL="NEXT"
  28 TITLE="poll"
  29 HREF="net-common-tcpip-manpages-poll.html"></HEAD
  30 ><BODY
  31 CLASS="SECT1"
  32 BGCOLOR="#FFFFFF"
  33 TEXT="#000000"
  34 LINK="#0000FF"
  35 VLINK="#840084"
  36 ALINK="#0000FF"
  37 ><DIV
  38 CLASS="NAVHEADER"
  39 ><TABLE
  40 SUMMARY="Header navigation table"
  41 WIDTH="100%"
  42 BORDER="0"
  43 CELLPADDING="0"
  44 CELLSPACING="0"
  45 ><TR
  46 ><TH
  47 COLSPAN="3"
  48 ALIGN="center"
  49 >eCos Reference Manual</TH
  50 ></TR
  51 ><TR
  52 ><TD
  53 WIDTH="10%"
  54 ALIGN="left"
  55 VALIGN="bottom"
  56 ><A
  57 HREF="net-common-tcpip-manpages-getsockopt.html"
  58 ACCESSKEY="P"
  59 >Prev</A
  60 ></TD
  61 ><TD
  62 WIDTH="80%"
  63 ALIGN="center"
  64 VALIGN="bottom"
  65 >Chapter 38. TCP/IP Library Reference</TD
  66 ><TD
  67 WIDTH="10%"
  68 ALIGN="right"
  69 VALIGN="bottom"
  70 ><A
  71 HREF="net-common-tcpip-manpages-poll.html"
  72 ACCESSKEY="N"
  73 >Next</A
  74 ></TD
  75 ></TR
  76 ></TABLE
  77 ><HR
  78 ALIGN="LEFT"
  79 WIDTH="100%"></DIV
  80 ><DIV
  81 CLASS="SECT1"
  82 ><H1
  83 CLASS="SECT1"
  84 ><A
  85 NAME="NET-COMMON-TCPIP-MANPAGES-IOCTL">ioctl</H1
  86 ><TABLE
  87 BORDER="5"
  88 BGCOLOR="#E0E0F0"
  89 WIDTH="70%"
  90 ><TR
  91 ><TD
  92 ><PRE
  93 CLASS="SCREEN"
  94 >IOCTL(2)                      System Calls Manual                     IOCTL(2)
  95
  96 NAME
  97      ioctl - control device
  98
  99 SYNOPSIS
 100      #include &lt;sys/ioctl.h&#62;
 101
 102      int
 103      ioctl(int d, unsigned long request, ...);
 104
 105 DESCRIPTION
 106      The ioctl() function manipulates the underlying device parameters of spe-
 107      cial files.  In particular, many operating characteristics of character
 108      special files (e.g., terminals) may be controlled with ioctl() requests.
 109
 110      The argument d must be an open file descriptor. The third argument is
 111      called arg and contains additional information needed by this device to
 112      perform the requested function.  arg is either an int or a pointer to a
 113      device-specific data structure, depending upon the given request.
 114
 115      An ioctl request has encoded in it whether the argument is an ``in''
 116      parameter or ``out'' parameter, and the size of the third argument (arg)
 117      in bytes.  Macros and defines used in specifying an ioctl request are
 118      located in the file &lt;sys/ioctl.h&#62;.
 119
 120 RETURN VALUES
 121      If an error has occurred, a value of -1 is returned and errno is set to
 122      indicate the error.
 123
 124 ERRORS
 125      ioctl() will fail if:
 126
 127      [EBADF]            d is not a valid descriptor.
 128
 129      [ENOTTY]           d is not associated with a character special device.
 130
 131      [ENOTTY]           The specified request does not apply to the kind of
 132                         object that the descriptor d references.
 133
 134      [EINVAL]           request or arg is not valid.
 135
 136      [EFAULT]           arg points outside the process's allocated address
 137                         space.
 138
 139 SEE ALSO
 140      cdio(1), chio(1), mt(1), execve(2), fcntl(2), intro(4), tty(4)
 141
 142 HISTORY
 143      An ioctl() function call appeared in Version 7 AT&amp;T UNIX.
 144
 145 BSD                            December 11, 1993                           BSD
 146     </PRE
 147 ></TD
 148 ></TR
 149 ></TABLE
 150 ></DIV
 151 ><DIV
 152 CLASS="NAVFOOTER"
 153 ><HR
 154 ALIGN="LEFT"
 155 WIDTH="100%"><TABLE
 156 SUMMARY="Footer navigation table"
 157 WIDTH="100%"
 158 BORDER="0"
 159 CELLPADDING="0"
 160 CELLSPACING="0"
 161 ><TR
 162 ><TD
 163 WIDTH="33%"
 164 ALIGN="left"
 165 VALIGN="top"
 166 ><A
 167 HREF="net-common-tcpip-manpages-getsockopt.html"
 168 ACCESSKEY="P"
 169 >Prev</A
 170 ></TD
 171 ><TD
 172 WIDTH="34%"
 173 ALIGN="center"
 174 VALIGN="top"
 175 ><A
 176 HREF="ecos-ref.html"
 177 ACCESSKEY="H"
 178 >Home</A
 179 ></TD
 180 ><TD
 181 WIDTH="33%"
 182 ALIGN="right"
 183 VALIGN="top"
 184 ><A
 185 HREF="net-common-tcpip-manpages-poll.html"
 186 ACCESSKEY="N"
 187 >Next</A
 188 ></TD
 189 ></TR
 190 ><TR
 191 ><TD
 192 WIDTH="33%"
 193 ALIGN="left"
 194 VALIGN="top"
 195 >getsockopt</TD
 196 ><TD
 197 WIDTH="34%"
 198 ALIGN="center"
 199 VALIGN="top"
 200 ><A
 201 HREF="tcpip-library-reference.html"
 202 ACCESSKEY="U"
 203 >Up</A
 204 ></TD
 205 ><TD
 206 WIDTH="33%"
 207 ALIGN="right"
 208 VALIGN="top"
 209 >poll</TD
 210 ></TR
 211 ></TABLE
 212 ></DIV
 213 ></BODY
 214 ></HTML
 215 >