man pages section 3: Basic Library Functions

Exit Print View

Updated: July 2014
 
 

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(7I)) 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(5) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
MT-Safe, and Async-Signal-Safe
Standard

See Also

tcsetattr(3C), attributes(5), standards(5), termio(7I)