Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

ptsname_r(3) [osf1 man page]

ptsname(3)						     Library Functions Manual							ptsname(3)

NAME
ptsname, ptsname_r - Gets the name of a slave pseudoterminal device LIBRARY
Standard C Library (libc) SYNOPSIS
#include <stdlib.h> char *ptsname( int masterfd); The following function is not defined in current industry standards and is supported only for backward compatibility. You should not use it in new designs. int ptsname_r( int masterfd, char *slavename, int len); STANDARDS
Interfaces documented on this reference page conform to industry standards as follows: ptsname(): XSH5.0 Refer to the standards(5) reference page for more information about industry standards and associated tags. PARAMETERS
Specifies a file descriptor that is returned from a successful open of the master pty. Points to the character array for the resulting null-terminated pathname of the slave pty. Specifies the length of the slave pty specified by slavename. This length must be 32 bytes. DESCRIPTION
The ptsname() function returns the name of the slave pseudoterminal device associated with a master pseudoterminal device. NOTES
The ptsname() function returns a pointer to thread-specific data. Subsequent calls to this function from the same thread overwrite this data. [Tru64 UNIX] The ptsname_r() function is an obsolete reentrant version of the ptsname() function. It is supported in order to maintain backward compatibility with previous versions of the operating system and should not be used in new designs. RETURN VALUES
Upon successful completion, the ptsname() function returns a pointer to a string that contains the pathname of the slave pseudoterminal device. The pathname has the form: /dev/pts /N. Upon failure, it returns a null pointer. The function can fail if the masterfd parameter is an invalid file descriptor or if the slave device name does not exist in the file system. [Tru64 UNIX] Upon successful completion, the ptsname_r() function stores a the string in slavename and returns a value of 0 (zero). Upon failure, it returns a value of -1 and may place an appropriate value in the errno variable. ERRORS
If the following conditions occur, the ptsname_r() function sets errno to the following value: [Tru64 UNIX] The slavename parameter is invalid or the len parameter is too small. RELATED INFORMATION
Functions: openpty(3), pty(7) Standards: standards(5) delim off ptsname(3)

Check Out this Related Man Page

PTSNAME(3)						     Linux Programmer's Manual							PTSNAME(3)

NAME
ptsname, ptsname_r - get the name of the slave pseudoterminal SYNOPSIS
#define _XOPEN_SOURCE /* See feature_test_macros(7) */ #include <stdlib.h> char *ptsname(int fd); #define _GNU_SOURCE /* See feature_test_macros(7) */ #include <stdlib.h> int ptsname_r(int fd, char *buf, size_t buflen); DESCRIPTION
The ptsname() function returns the name of the slave pseudoterminal device corresponding to the master referred to by fd. The ptsname_r() function is the reentrant equivalent of ptsname(). It returns the name of the slave pseudoterminal device as a null-termi- nated string in the buffer pointed to by buf. The buflen argument specifies the number of bytes available in buf. RETURN VALUE
On success, ptsname() returns a pointer to a string in static storage which will be overwritten by subsequent calls. This pointer must not be freed. On failure, a NULL pointer is returned. On success, ptsname_r() returns 0. On failure, a nonzero value is returned and errno is set to indicate the error. ERRORS
EINVAL (ptsname_r() only) buf is NULL. ENOTTY fd does not refer to a pseudoterminal master device. ERANGE (ptsname_r() only) buf is too small. VERSIONS
ptsname() is provided in glibc since version 2.1. CONFORMING TO
ptsname() is part of the UNIX 98 pseudoterminal support (see pts(4)). This function is specified in POSIX.1-2001. ptsname_r() is a Linux extension. A version of this function is documented on Tru64 and HP-UX, but on those implementations, -1 is returned on error, with errno set to indicate the error. Avoid using this function in portable programs. SEE ALSO
grantpt(3), posix_openpt(3), ttyname(3), unlockpt(3), pts(4), pty(7) COLOPHON
This page is part of release 3.44 of the Linux man-pages project. A description of the project, and information about reporting bugs, can be found at http://www.kernel.org/doc/man-pages/. 2008-09-03 PTSNAME(3)
Man Page