NAME

tcgetattr − Gets the parameters associated with the terminal

LIBRARY

Standard C Library (libc.a)

SYNOPSIS

#include <termios.h>
int tcgetattr (
int file_des,
struct termios ∗termios_p );

PARAMETERS

file_des
Specifies an open file descriptor associated with a terminal.

termios_p
Points to a termios structure. 

DESCRIPTION

The tcgetattr() function gets the parameters associated with the object referenced by the file_des parameter and stores them in the termios structure referenced by the termios_p parameter.

If the device does not support split baud rates, the input baud rate stored in the termios structure will be 0 (zero). 

The tcgetattr() function may be called from any process. 

NOTES

AES Support Level: Full use

RETURN VALUES

Upon successful completion, 0 (zero) is returned. Otherwise, −1 is returned and errno is set to indicate the error.

ERRORS

If the tcgetattr() function fails, errno may be set to one of the following values:

[EBADF] The file_des parameter is not a valid file descriptor.

[ENOTTY] The file associated with the file_des parameter is not a terminal.

RELATED INFORMATION

Functions: tcsetattr(3)

Files: termios(4)