Content-type: text/html Man page of tcgetattr

tcgetattr

Section: C Library Functions (3)
Index Return to Main Contents
 

NAME

tcgetattr - Gets the parameters associated with the terminal  

LIBRARY

Standard C Library (libc.so, libc.a)  

SYNOPSIS

#include <termios.h>

int tcgetattr (
        int filedes,
        struct termios *termios_p );  

STANDARDS

Interfaces documented on this reference page conform to industry standards as follows:

tcgetattr():  XPG4, XPG4-UNIX

Refer to the standards(5) reference page for more information about industry standards and associated tags.  

PARAMETERS

Specifies an open file descriptor associated with a terminal. Points to a termios structure.  

DESCRIPTION

The tcgetattr() function gets the parameters associated with the object referenced by the filedes 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.  

RETURN VALUES

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

ERRORS

The tcgetattr() function sets errno to the specified values for the following conditions:

The filedes parameter is not a valid file descriptor. The file associated with the filedes parameter is not a terminal.  

RELATED INFORMATION

Functions: tcsetattr(3)

Files: termios(4)

Standards: standards(5) delim off


 

Index

NAME
LIBRARY
SYNOPSIS
STANDARDS
PARAMETERS
DESCRIPTION
RETURN VALUES
ERRORS
RELATED INFORMATION

This document was created by man2html, using the manual pages.
Time: 02:41:05 GMT, October 02, 2010