Go to main content

man pages section 3: Basic Library Functions

Exit Print View

Updated: Thursday, June 13, 2019
 
 

ttyname_r(3C)

Name

ttyname, ttyname_r - find pathname of a terminal

Synopsis

#include <unistd.h> 

char *ttyname(int fildes);
int ttyname_r(int fildes, char *name, size_t namesize);
POSIX.1c Draft 6
  cc [ flag...] file ... –D__USE_DRAFT6_PROTOTYPES__ [ library ... ]
 
char *ttyname_r(int fildes, char *name, int namelen);

Description

The ttyname() function returns a pointer to a string containing the null-terminated path name of the terminal device associated with file descriptor fildes. The return value points to thread–specific data whose content is overwritten by each call from the same thread.

The ttyname_r() function has the same functionality as ttyname() except that the caller must supply a buffer name with size namesize to store the result; this buffer must be at least _POSIX_PATH_MAX in size (defined in <limits.h>).

Return Values

Upon successful completion, ttyname() returns a pointer to a string. Otherwise, a null pointer is returned and errno is set to indicate the error.

The ttyname_r() function returns 0 if successful or the error number upon failure; it does not set errno.

Errors

The ttyname() and ttyname_r() functions may fail if:

EBADF

The fildes argument is not a valid file descriptor. This condition is reported.

ENOTTY

The fildes argument does not refer to a terminal device. This condition is reported.

The ttyname_r() function may fail if:

ERANGE

The value of namesize is smaller than the length of the string to be returned including the terminating null character.

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
Safe
Standard

See Also

gettext(3C), setlocale(3C), ttysrch(5), attributes(7), standards(7)

Notes

Messages printed from this function are in the native language specified by the LC_MESSAGES locale category. See setlocale(3C).

The return value of ttyname() points to thread–specific data whose content is overwritten by each call from the same thread. This function is safe to use in multithreaded applications, but its use is discouraged. The ttyname_r() function should used instead.

Prior to Oracle Solaris 11.4, the default compilation environment provided a definition of the ttyname_r() function as specified in POSIX.1c Draft 6. The final POSIX.1c standard changed the interface for ttyname_r(). To allow applications that were written to use the obsolete Draft-6 interfaces to continue to be compiled and run, the __USE_DRAFT6_PROTOTYPES__ macro must be defined:

cc –D__USE_DRAFT6_PROTOTYPES__ ...

Support for the Draft-6 interfaces is provided for source compatibility only and might not be supported in future releases. Old applications should be converted to use the standard definitions.