TCGETATTR(3C) Standard C Library Functions TCGETATTR(3C)
NAME
tcgetattr - get the parameters associated with the terminal
SYNOPSIS
#include <termios.h>
int tcgetattr(
int fildes,
struct termios *termios_p);
DESCRIPTION
The
tcgetattr() function gets the parameters associated with the
terminal referred to by
fildes and stores them in the
termios structure (see
termio(4I)) referenced by
termios_p. The
fildes argument is an open file descriptor associated with a terminal.
The
termios_p argument is a pointer to a
termios structure.
The
tcgetattr() operation is allowed from any process.
If the terminal device supports different input and output baud
rates, the baud rates stored in the
termios structure returned by
tcgetattr() reflect the actual baud rates, even if they are equal. If
differing baud rates are not supported, the rate returned as the
output baud rate is the actual baud rate. If the terminal device does
not support split baud rates, the input baud rate stored in the
termios structure will be 0.
RETURN VALUES
Upon successful completion,
0 is returned. Otherwise,
-1 is returned
and
errno is set to indicate the error.
ERRORS
The
tcgetattr() function will fail if:
EBADF The
fildes argument is not a valid file descriptor.
ENOTTY The file associated with
fildes is not a terminal.
ATTRIBUTES
See
attributes(7) for descriptions of the following attributes:
+--------------------+--------------------------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+--------------------------------+
|Interface Stability | Standard |
+--------------------+--------------------------------+
|MT-Level | MT-Safe, and Async-Signal-Safe |
+--------------------+--------------------------------+
SEE ALSO
tcsetattr(3C),
termio(4I),
attributes(7),
standards(7) August 14, 2002 TCGETATTR(3C)
