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



PPRROOLLOOGG
       This manual page is part of the POSIX Programmer's Manual.  The OS
       implementation of this interface may differ (consult the corresponding
       OS manual page for details of OS behavior), or the interface may not be
       implemented on OS.

NNAAMMEE
       ptsname -- get name of the slave pseudo-terminal device

SSYYNNOOPPSSIISS
       #include <stdlib.h>

       char *ptsname(int _f_i_l_d_e_s);

DDEESSCCRRIIPPTTIIOONN
       The _p_t_s_n_a_m_e() function shall return the name of the slave pseudo-
       terminal device associated with a master pseudo-terminal device. The
       _f_i_l_d_e_s argument is a file descriptor that refers to the master device.
       The _p_t_s_n_a_m_e() function shall return a pointer to a string containing
       the pathname of the corresponding slave device.

       The _p_t_s_n_a_m_e() function need not be thread-safe.

RREETTUURRNN VVAALLUUEE
       Upon successful completion, _p_t_s_n_a_m_e() shall return a pointer to a
       string which is the name of the pseudo-terminal slave device. Upon
       failure, _p_t_s_n_a_m_e() shall return a null pointer and may set _e_r_r_n_o.  This
       could occur if _f_i_l_d_e_s is an invalid file descriptor or if the slave
       device name does not exist in the file system.

       The application shall not modify the string returned. The returned
       pointer might be invalidated or the string content might be overwritten
       by a subsequent call to _p_t_s_n_a_m_e().  The returned pointer and the string
       content might also be invalidated if the calling thread is terminated.

EERRRROORRSS
       The _p_t_s_n_a_m_e() function may fail if:

       EEBBAADDFF  The _f_i_l_d_e_s argument is not a valid file descriptor.

       EENNOOTTTTYY The file associated with the _f_i_l_d_e_s argument is not a master
              pseudo-terminal device.

       _T_h_e _f_o_l_l_o_w_i_n_g _s_e_c_t_i_o_n_s _a_r_e _i_n_f_o_r_m_a_t_i_v_e_.

EEXXAAMMPPLLEESS
       None.

AAPPPPLLIICCAATTIIOONN UUSSAAGGEE
       None.

RRAATTIIOONNAALLEE
       See the RATIONALE section for _p_o_s_i_x___o_p_e_n_p_t().

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       None.

SSEEEE AALLSSOO
       _g_r_a_n_t_p_t(), _o_p_e_n(), _p_o_s_i_x___o_p_e_n_p_t(), _t_t_y_n_a_m_e(), _u_n_l_o_c_k_p_t()

       The Base Definitions volume of POSIX.1-2017, <<ssttddlliibb..hh>>

CCOOPPYYRRIIGGHHTT
       Portions of this text are reprinted and reproduced in electronic form
       from IEEE Std 1003.1-2017, Standard for Information Technology --
       Portable Operating System Interface (POSIX), The Open Group Base
       Specifications Issue 7, 2018 Edition, Copyright (C) 2018 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 .

       Any typographical or formatting errors that appear in this page are
       most likely to have been introduced during the conversion of the source
       files to man page format. To report such errors, see
       https://www.kernel.org/doc/man-pages/reporting_bugs.html .



IEEE/The Open Group                  2017                           PTSNAME(3)
