usr/src/man/man3c/tcgetattr.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 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 .\" Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
  44 .\" Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved.
  45 .\"
  46 .TH TCGETATTR 3C "Aug 14, 2002"
  47 .SH NAME
  48 tcgetattr \- get the parameters associated with the terminal
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <termios.h>
  53
  54 \fBint\fR \fBtcgetattr\fR(\fBint\fR \fIfildes\fR, \fBstruct termios *\fR\fItermios_p\fR);
  55 .fi
  56
  57 .SH DESCRIPTION
  58 .sp
  59 .LP
  60 The \fBtcgetattr()\fR function gets the parameters associated with the terminal
  61 referred to by \fIfildes\fR and stores them in the \fBtermios\fR structure (see
  62 \fBtermio\fR(7I)) referenced by \fItermios_p\fR. The \fIfildes\fR argument is
  63 an open file descriptor associated with a terminal.
  64 .sp
  65 .LP
  66 The \fItermios_p\fR argument is a pointer to a \fBtermios\fR structure.
  67 .sp
  68 .LP
  69 The \fBtcgetattr()\fR operation is allowed from any process.
  70 .sp
  71 .LP
  72 If the terminal device supports different input and output baud rates, the baud
  73 rates stored in the \fBtermios\fR structure returned by \fBtcgetattr()\fR
  74 reflect the actual baud rates, even if they are equal. If differing baud rates
  75 are not supported, the rate returned as the output baud rate is the actual baud
  76 rate. If the terminal device does not support split baud rates, the input baud
  77 rate stored in the \fBtermios\fR structure will be 0.
  78 .SH RETURN VALUES
  79 .sp
  80 .LP
  81 Upon successful completion, \fB0\fR is returned. Otherwise, \fB\(mi1\fR is
  82 returned and \fBerrno\fR is set to indicate the error.
  83 .SH ERRORS
  84 .sp
  85 .LP
  86 The \fBtcgetattr()\fR function will fail if:
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fBEBADF\fR\fR
  91 .ad
  92 .RS 10n
  93 The \fIfildes\fR argument is not a valid file descriptor.
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fBENOTTY\fR\fR
 100 .ad
 101 .RS 10n
 102 The file associated with \fIfildes\fR is not a terminal.
 103 .RE
 104
 105 .SH ATTRIBUTES
 106 .sp
 107 .LP
 108 See \fBattributes\fR(5) for descriptions of the following attributes:
 109 .sp
 110
 111 .sp
 112 .TS
 113 box;
 114 c | c
 115 l | l .
 116 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 117 _
 118 Interface Stability     Standard
 119 _
 120 MT-Level        MT-Safe, and Async-Signal-Safe
 121 .TE
 122
 123 .SH SEE ALSO
 124 .sp
 125 .LP
 126 \fBtcsetattr\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5), \fBtermio\fR(7I)