| Click this button to go to the index for this section. |
ptsname(3)
NAME
ptsname, ptsname_r - Gets the name of a slave pseudoterminal deviceLIBRARY
Standard C Library (libc.so, libc.a)SYNOPSIS
#include <stdlib.h> char *ptsname( int masterfd); [Digital] The following obsolete function is supported in order to maintain backward compatibility with previous versions of the operating system. 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(): XPG4-UNIX Refer to the standards(5) reference page for more information about industry standards and associated tags.PARAMETERS
masterfd Specifies a file descriptor that is returned from a successful open of the master pty. slavename Points to the character array for the resulting null-terminated pathname of the slave pty. len 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. [Digital] 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. [Digital] 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: [EINVAL] [Digital] The slavename parameter is invalid or the len parameter is too small.RELATED INFORMATION
Functions: openpty(3), pty(7) Standards: standards(5) Guides: System V Compatibility User's Guide