Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

ttyname(3c) [opensolaris man page]

ttyname(3C)						   Standard C Library Functions 					       ttyname(3C)

NAME
ttyname, ttyname_r - find pathname of a terminal SYNOPSIS
#include <unistd.h> char *ttyname(int fildes); char *ttyname_r(int fildes, char *name, int namelen); Standard conforming cc [ flag...] file ... -D_POSIX_PTHREAD_SEMANTICS [ library ... ] int ttyname_r(int fildes, char *name, size_t namesize); 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 length namelen to store the result; this buffer must be at least _POSIX_PATH_MAX in size (defined in <limits.h>). The standard-conforming version (see stan- dards(5)) of ttyname_r() takes a namesize parameter of type size_t. RETURN VALUES
Upon successful completion, ttyname() and ttyname_r() return a pointer to a string. Otherwise, a null pointer is returned and errno is set to indicate the error. The standard-conforming ttyname_r() returns 0 if successful or the error number upon failure. 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(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability |Standard | +-----------------------------+-----------------------------+ |MT-Level |Safe | +-----------------------------+-----------------------------+ SEE ALSO
Intro(3), gettext(3C), setlocale(3C), attributes(5), standards(5) NOTES
When compiling multithreaded applications, see Intro(3), Notes On Multithreaded Applications. 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. Solaris 2.4 and earlier releases provided definitions of the ttyname_r() interface as specified in POSIX.1c Draft 6. The final POSIX.1c standard changed the interface as described above. Support for the Draft 6 interface is provided for compatibility only and might not be supported in future releases. New applications and libraries should use the standard-conforming interface. SunOS 5.11 31 Mar 2005 ttyname(3C)

Check Out this Related Man Page

TTYNAME(3P)						     POSIX Programmer's Manual						       TTYNAME(3P)

PROLOG
This manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may differ (consult the correspond- ing Linux manual page for details of Linux behavior), or the interface may not be implemented on Linux. NAME
ttyname, ttyname_r - find the pathname of a terminal SYNOPSIS
#include <unistd.h> char *ttyname(int fildes); int ttyname_r(int fildes, char *name, size_t namesize); DESCRIPTION
The ttyname() function shall return a pointer to a string containing a null-terminated pathname of the terminal associated with file descriptor fildes. The return value may point to static data whose content is overwritten by each call. The ttyname() function need not be reentrant. A function that is not required to be reentrant is not required to be thread-safe. The ttyname_r() function shall store the null-terminated pathname of the terminal associated with the file descriptor fildes in the charac- ter array referenced by name. The array is namesize characters long and should have space for the name and the terminating null character. The maximum length of the terminal name shall be {TTY_NAME_MAX}. RETURN VALUE
Upon successful completion, ttyname() shall return a pointer to a string. Otherwise, a null pointer shall be returned and errno set to indicate the error. If successful, the ttyname_r() function shall return zero. Otherwise, an error number shall be returned to indicate the error. ERRORS
The ttyname() function may fail if: EBADF The fildes argument is not a valid file descriptor. ENOTTY The fildes argument does not refer to a terminal. The ttyname_r() function may fail if: EBADF The fildes argument is not a valid file descriptor. ENOTTY The fildes argument does not refer to a terminal. ERANGE The value of namesize is smaller than the length of the string to be returned including the terminating null character. The following sections are informative. EXAMPLES
None. APPLICATION USAGE
None. RATIONALE
The term ``terminal'' is used instead of the historical term ``terminal device'' in order to avoid a reference to an undefined term. The thread-safe version places the terminal name in a user-supplied buffer and returns a non-zero value if it fails. The non-thread-safe version may return the name in a static data area that may be overwritten by each call. FUTURE DIRECTIONS
None. SEE ALSO
The Base Definitions volume of IEEE Std 1003.1-2001, <unistd.h> COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1, 2003 Edition, Standard for Information Technol- ogy -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between this version and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html . IEEE
/The Open Group 2003 TTYNAME(3P)
Man Page