1.\" 2.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for 3.\" permission to reproduce portions of its copyrighted documentation. 4.\" Original documentation from The Open Group can be obtained online at 5.\" http://www.opengroup.org/bookstore/. 6.\" 7.\" The Institute of Electrical and Electronics Engineers and The Open 8.\" Group, have given us permission to reprint portions of their 9.\" documentation. 10.\" 11.\" In the following statement, the phrase ``this text'' refers to portions 12.\" of the system documentation. 13.\" 14.\" Portions of this text are reprinted and reproduced in electronic form 15.\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition, 16.\" Standard for Information Technology -- Portable Operating System 17.\" Interface (POSIX), The Open Group Base Specifications Issue 6, 18.\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics 19.\" Engineers, Inc and The Open Group. In the event of any discrepancy 20.\" between these versions and the original IEEE and The Open Group 21.\" Standard, the original IEEE and The Open Group Standard is the referee 22.\" document. The original Standard can be obtained online at 23.\" http://www.opengroup.org/unix/online.html. 24.\" 25.\" This notice shall appear on any product containing this material. 26.\" 27.\" The contents of this file are subject to the terms of the 28.\" Common Development and Distribution License (the "License"). 29.\" You may not use this file except in compliance with the License. 30.\" 31.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 32.\" or http://www.opensolaris.org/os/licensing. 33.\" See the License for the specific language governing permissions 34.\" and limitations under the License. 35.\" 36.\" When distributing Covered Code, include this CDDL HEADER in each 37.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE. 38.\" If applicable, add the following below this CDDL HEADER, with the 39.\" fields enclosed by brackets "[]" replaced with your own identifying 40.\" information: Portions Copyright [yyyy] [name of copyright owner] 41.\" 42.\" 43.\" Copyright 1989 AT&T 44.\" Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved 45.\" Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved. 46.\" Copyright 2022 Oxide Computer Company 47.\" 48.Dd February 5, 2022 49.Dt PTSNAME 3C 50.Os 51.Sh NAME 52.Nm ptsname 53.Nd get the name of the subsidiary device of a pseudo-terminal 54.Sh SYNOPSIS 55.In stdlib.h 56.Ft char * 57.Fo ptsname 58.Fa "int fildes" 59.Fc 60.Sh DESCRIPTION 61The 62.Fn ptsname 63function returns the name of the pseudo-terminal subsidiary device associated 64with a pseudo-terminal manager device. 65The 66.Fa fildes 67argument is a file descriptor returned from a successful open of the 68pseudo-terminal manager device; e.g., by calling 69.Xr posix_openpt 3C 70or by performing an 71.Xr open 2 72of the 73.Xr ptm 4D 74device. 75.Pp 76The 77.Fn ptsname 78function returns a pointer to a string containing the null-terminated 79path name of the subsidiary device. 80This string is of the form 81.Pa /dev/pts/N , 82where 83.Sy N 84is a non-negative integer. 85.Sh RETURN VALUES 86If successful, the 87.Fn ptsname 88function returns a pointer to a string which is the name of the pseudo-terminal 89subsidiary device. 90This value points to a static data area that is overwritten by each call to 91.Fn ptsname . 92.Pp 93Upon failure, 94.Fn ptsname 95returns 96.Dv NULL . 97This could occur if 98.Fa fildes 99is an invalid file descriptor or if the subsidiary device name does not exist 100in the file system. 101.Sh INTERFACE STABILITY 102.Sy Committed 103.Sh MT LEVEL 104.Sy Safe 105.Sh SEE ALSO 106.Xr open 2 , 107.Xr grantpt 3C , 108.Xr posix_openpt 3C , 109.Xr ttyname 3C , 110.Xr unlockpt 3C , 111.Xr ptm 4D , 112.Xr pts 4D , 113.Xr attributes 7 , 114.Xr standards 7 115