ptsname(3)

1PTSNAME(3)                 Linux Programmer's Manual                PTSNAME(3)
2
3
4

NAME

6       ptsname, ptsname_r - get the name of the slave pseudoterminal
7

SYNOPSIS

9       #define _XOPEN_SOURCE       /* See feature_test_macros(7) */
10       #include <stdlib.h>
11
12       char *ptsname(int fd);
13
14       #define _GNU_SOURCE         /* See feature_test_macros(7) */
15       #include <stdlib.h>
16
17       int ptsname_r(int fd, char *buf, size_t buflen);
18

DESCRIPTION

20       The  ptsname()  function  returns  the name of the slave pseudoterminal
21       device corresponding to the master referred to by fd.
22
23       The ptsname_r() function is the reentrant equivalent of ptsname().   It
24       returns  the  name  of the slave pseudoterminal device as a null-termi‐
25       nated string in the buffer pointed to  by  buf.   The  buflen  argument
26       specifies the number of bytes available in buf.
27

RETURN VALUE

29       On  success,  ptsname() returns a pointer to a string in static storage
30       which will be overwritten by subsequent calls.  This pointer  must  not
31       be freed.  On failure, a NULL pointer is returned.
32
33       On  success,  ptsname_r()  returns  0.   On failure, a nonzero value is
34       returned and errno is set to indicate the error.
35

ERRORS

37       EINVAL (ptsname_r() only) buf is NULL.
38
39       ENOTTY fd does not refer to a pseudoterminal master device.
40
41       ERANGE (ptsname_r() only) buf is too small.
42

VERSIONS

44       ptsname() is provided in glibc since version 2.1.
45

ATTRIBUTES

47   Multithreading (see pthreads(7))
48       The ptsname() function is not thread-safe.
49
50       The ptsname_r() function is thread-safe.
51

CONFORMING TO

53       ptsname() is part of the UNIX 98 pseudoterminal support  (see  pts(4)).
54       This function is specified in POSIX.1-2001.
55
56       ptsname_r()  is a Linux extension.  A version of this function is docu‐
57       mented on Tru64 and HP-UX, but on those implementations, -1 is returned
58       on error, with errno set to indicate the error.  Avoid using this func‐
59       tion in portable programs.
60

COLOPHON

65       This page is part of release 3.53 of the Linux  man-pages  project.   A
66       description  of  the project, and information about reporting bugs, can
67       be found at http://www.kernel.org/doc/man-pages/.
68
69
70
71                                  2013-06-21                        PTSNAME(3)