1.\" $NetBSD: ptsname.3,v 1.4 2004/07/01 10:38:28 kleink Exp $ 2.\" 3.\" Copyright (c) 2004 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" 6.\" This code is derived from software contributed to The NetBSD Foundation 7.\" by Christos Zoulas. 8.\" 9.\" Redistribution and use in source and binary forms, with or without 10.\" modification, are permitted provided that the following conditions 11.\" are met: 12.\" 1. Redistributions of source code must retain the above copyright 13.\" notice, this list of conditions and the following disclaimer. 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 3. All advertising materials mentioning features or use of this software 18.\" must display the following acknowledgement: 19.\" This product includes software developed by the NetBSD 20.\" Foundation, Inc. and its contributors. 21.\" 4. Neither the name of The NetBSD Foundation nor the names of its 22.\" contributors may be used to endorse or promote products derived 23.\" from this software without specific prior written permission. 24.\" 25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 28.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 35.\" POSSIBILITY OF SUCH DAMAGE. 36.\" 37.Dd May 25, 2004 38.Dt PTSNAME 3 39.Os 40.Sh NAME 41.Nm ptsname 42.Nd get the pathname of the slave pseudo-terminal device 43.Sh LIBRARY 44.Lb libc 45.Sh SYNOPSIS 46.In stdlib.h 47.Ft char * 48.Fn ptsname "int masterfd" 49.Sh DESCRIPTION 50The 51.Fn ptsname 52function returns the pathname of the slave pseudo-terminal device 53that corresponds to the master pseudo-terminal device associated with 54.Fa masterfd . 55The 56.Fn ptsname 57function is not reentrant or thread-safe. 58.Sh RETURN VALUES 59If successful, 60.Fn ptsname 61returns a pointer to a nul-terminated string containing the pathname 62of the slave pseudo-terminal device. 63If an error occurs 64.Fn ptsname 65will return 66.Dv NULL 67and 68.Va errno 69is set to indicate the error. 70.Sh ERRORS 71The 72.Fn ptsname 73function will fail if: 74.Bl -tag -width Er 75.It Bq Er EACCESS 76the corresponding pseudo-terminal device could not be accessed. 77.It Bq Er EBADF 78.Fa masterfd 79is not a valid descriptor. 80.It Bq Er EINVAL 81.Fa masterfd 82is not associated with a master pseudo-terminal device. 83.El 84.Sh NOTES 85The error returns of 86.Fn ptsname 87are a 88.Nx 89extension. 90The 91.Fn ptsname 92function is equivalent to: 93.Bd -literal 94 struct ptmget pm; 95 return ioctl(masterfd, TIOCPTSNAME, \*[Am]pm) == -1 ? NULL : pm.ps; 96.Ed 97.Sh SEE ALSO 98.Xr ioctl 2 , 99.Xr grantpt 3 , 100.Xr posix_openpt 3 , 101.Xr unlockpt 3 102.Sh STANDARDS 103The 104.Fn ptsname 105function conforms to 106.St -p1003.1-2001 . 107Its first release was in 108.St -xpg4.2 . 109