usr/src/man/man3c/tcgetattr.3c

   1 '\" te
   2 .\"  Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved  Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" 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.
   8 .\" 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.
   9 .\" 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]
  10 .TH TCGETATTR 3C "Aug 14, 2002"
  11 .SH NAME
  12 tcgetattr \- get the parameters associated with the terminal
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <termios.h>
  17
  18 \fBint\fR \fBtcgetattr\fR(\fBint\fR \fIfildes\fR, \fBstruct termios *\fR\fItermios_p\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 The \fBtcgetattr()\fR function gets the parameters associated with the terminal
  25 referred to by \fIfildes\fR and stores them in the \fBtermios\fR structure (see
  26 \fBtermio\fR(7I)) referenced by \fItermios_p\fR. The \fIfildes\fR argument is
  27 an open file descriptor associated with a terminal.
  28 .sp
  29 .LP
  30 The \fItermios_p\fR argument is a pointer to a \fBtermios\fR structure.
  31 .sp
  32 .LP
  33 The \fBtcgetattr()\fR operation is allowed from any process.
  34 .sp
  35 .LP
  36 If the terminal device supports different input and output baud rates, the baud
  37 rates stored in the \fBtermios\fR structure returned by \fBtcgetattr()\fR
  38 reflect the actual baud rates, even if they are equal. If differing baud rates
  39 are not supported, the rate returned as the output baud rate is the actual baud
  40 rate. If the terminal device does not support split baud rates, the input baud
  41 rate stored in the \fBtermios\fR structure will be 0.
  42 .SH RETURN VALUES
  43 .sp
  44 .LP
  45 Upon successful completion, \fB0\fR is returned. Otherwise, \fB\(mi1\fR is
  46 returned and \fBerrno\fR is set to indicate the error.
  47 .SH ERRORS
  48 .sp
  49 .LP
  50 The \fBtcgetattr()\fR function will fail if:
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fBEBADF\fR\fR
  55 .ad
  56 .RS 10n
  57 The \fIfildes\fR argument is not a valid file descriptor.
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBENOTTY\fR\fR
  64 .ad
  65 .RS 10n
  66 The file associated with \fIfildes\fR is not a terminal.
  67 .RE
  68
  69 .SH ATTRIBUTES
  70 .sp
  71 .LP
  72 See \fBattributes\fR(5) for descriptions of the following attributes:
  73 .sp
  74
  75 .sp
  76 .TS
  77 box;
  78 c | c
  79 l | l .
  80 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  81 _
  82 Interface Stability     Standard
  83 _
  84 MT-Level        MT-Safe, and Async-Signal-Safe
  85 .TE
  86
  87 .SH SEE ALSO
  88 .sp
  89 .LP
  90 \fBtcsetattr\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5), \fBtermio\fR(7I)