usr/src/man/man3head/stdio.h.3head

   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 contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  44 .\" Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
  45 .\"
  46 .TH STDIO.H 3HEAD "Sep 10, 2004"
  47 .SH NAME
  48 stdio.h, stdio \- standard buffered input/output
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <\fBstdio.h\fR>
  53 .fi
  54
  55 .SH DESCRIPTION
  56 .sp
  57 .LP
  58 The <\fBstdio.h\fR> header defines the following macros as positive integer
  59 constant expressions:
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBBUFSIZ\fR\fR
  64 .ad
  65 .RS 13n
  66 size of <\fBstdio.h\fR> buffers
  67 .RE
  68
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fB_IOFBF\fR\fR
  73 .ad
  74 .RS 13n
  75 input/output fully buffered
  76 .RE
  77
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fB_IOLBF\fR\fR
  82 .ad
  83 .RS 13n
  84 input/output line buffered
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fB_IONBF\fR\fR
  91 .ad
  92 .RS 13n
  93 input/output unbuffered
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fBL_ctermid\fR\fR
 100 .ad
 101 .RS 13n
 102 maximum size of character array to hold \fBctermid()\fR output
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fBL_tmpnam\fR\fR
 109 .ad
 110 .RS 13n
 111 maximum size of character array to hold \fBtmpnam()\fR output
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fBSEEK_CUR\fR\fR
 118 .ad
 119 .RS 13n
 120 seek relative to current position
 121 .RE
 122
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fBSEEK_END\fR\fR
 127 .ad
 128 .RS 13n
 129 seek relative to end-of-file
 130 .RE
 131
 132 .sp
 133 .ne 2
 134 .na
 135 \fB\fBSEEK_SET\fR\fR
 136 .ad
 137 .RS 13n
 138 seek relative to start-of-file
 139 .RE
 140
 141 .sp
 142 .LP
 143 The following macros are defined as positive integer constant expressions that
 144 denote implementation limits:
 145 .sp
 146 .ne 2
 147 .na
 148 \fB{\fBFILENAME_MAX\fR}\fR
 149 .ad
 150 .RS 18n
 151 Maximum size in bytes of the longest filename string that the implementation
 152 guarantees can be opened.
 153 .RE
 154
 155 .sp
 156 .ne 2
 157 .na
 158 \fB{\fBFOPEN_MAX\fR}\fR
 159 .ad
 160 .RS 18n
 161 Number of streams that the implementation guarantees can be open
 162 simultaneously. The value is at least eight.
 163 .RE
 164
 165 .sp
 166 .ne 2
 167 .na
 168 \fB{\fBTMP_MAX\fR}\fR
 169 .ad
 170 .RS 18n
 171 Minimum number of unique filenames generated by \fBtmpnam()\fR. Maximum number
 172 of times an application can call \fBtmpnam()\fR reliably. The value of
 173 {\fBTMP_MAX\fR} is at least 25. On XSI-conformant systems, the value of
 174 {\fBTMP_MAX\fR} is at least 10000.
 175 .RE
 176
 177 .sp
 178 .LP
 179 The following macro name is defined as a negative integer constant expression:
 180 .sp
 181 .ne 2
 182 .na
 183 \fB\fBEOF\fR\fR
 184 .ad
 185 .RS 7n
 186 end-of-file return value
 187 .RE
 188
 189 .sp
 190 .LP
 191 The following macro name is defined as a null pointer constant:
 192 .sp
 193 .ne 2
 194 .na
 195 \fB\fBNULL\fR\fR
 196 .ad
 197 .RS 8n
 198 null pointer
 199 .RE
 200
 201 .sp
 202 .LP
 203 The following macro name is defined as a string constant:
 204 .sp
 205 .ne 2
 206 .na
 207 \fB\fBP_tmpdir\fR\fR
 208 .ad
 209 .RS 12n
 210 default directory prefix for \fBtempnam()\fR
 211 .RE
 212
 213 .sp
 214 .LP
 215 The following is defined as expressions of type "pointer to \fBFILE\fR" point
 216 to the \fBFILE\fR objects associated, respectively, with the standard error,
 217 input, and output streams:
 218 .sp
 219 .ne 2
 220 .na
 221 \fB\fBstderr\fR\fR
 222 .ad
 223 .RS 10n
 224 standard error output stream
 225 .RE
 226
 227 .sp
 228 .ne 2
 229 .na
 230 \fB\fBstdin\fR\fR
 231 .ad
 232 .RS 10n
 233 standard input stream
 234 .RE
 235
 236 .sp
 237 .ne 2
 238 .na
 239 \fB\fBstdout\fR\fR
 240 .ad
 241 .RS 10n
 242 standard output stream
 243 .RE
 244
 245 .sp
 246 .LP
 247 The following data types are defined through \fBtypedef\fR:
 248 .sp
 249 .ne 2
 250 .na
 251 \fB\fBFILE\fR\fR
 252 .ad
 253 .RS 11n
 254 structure containing information about a file
 255 .RE
 256
 257 .sp
 258 .ne 2
 259 .na
 260 \fB\fBfpos_t\fR\fR
 261 .ad
 262 .RS 11n
 263 non-array type containing all information needed to specify uniquely every
 264 position within a file
 265 .RE
 266
 267 .sp
 268 .ne 2
 269 .na
 270 \fB\fBva_list\fR\fR
 271 .ad
 272 .RS 11n
 273 as described in <\fBstdarg.h\fR>
 274 .RE
 275
 276 .sp
 277 .ne 2
 278 .na
 279 \fB\fBsize_t\fR\fR
 280 .ad
 281 .RS 11n
 282 as described in <\fBstddef.h\fR>
 283 .RE
 284
 285 .SH ATTRIBUTES
 286 .sp
 287 .LP
 288 See \fBattributes\fR(5) for descriptions of the following attributes:
 289 .sp
 290
 291 .sp
 292 .TS
 293 box;
 294 c | c
 295 l | l .
 296 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 297 _
 298 Interface Stability     Standard
 299 .TE
 300
 301 .SH SEE ALSO
 302 .sp
 303 .LP
 304 \fBrename\fR(2), \fBctermid\fR(3C), \fBfclose\fR(3C), \fBfdopen\fR(3C),
 305 \fBfflush\fR(3C), \fBfgetc\fR(3C), \fBfgetpos\fR(3C), \fBfgets\fR(3C),
 306 \fBflockfile\fR(3C), \fBfopen\fR(3C), \fBfputc\fR(3C), \fBfputs\fR(3C),
 307 \fBfputwc\fR(3C), \fBfread\fR(3C), \fBfreopen\fR(3C), \fBfseek\fR(3C),
 308 \fBfsetpos\fR(3C), \fBftell\fR(3C), \fBfwrite\fR(3C), \fBgetwchar\fR(3C),
 309 \fBgetopt\fR(3C), \fBperror\fR(3C), \fBpopen\fR(3C), \fBprintf\fR(3C),
 310 \fBremove\fR(3C), \fBrewind\fR(3C), \fBscanf\fR(3C), \fBsetbuf\fR(3C),
 311 \fBstdio\fR(3C), \fBsystem\fR(3C), \fBtmpfile\fR(3C), \fBtmpnam\fR(3C),
 312 \fBungetc\fR(3C), \fBvprintf\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)