usr/src/man/man3c/posix_openpt.3c

   1 '\" te
   2 .\" Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
   3 .\" Portions Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions 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.
   7 .\"  This notice shall appear on any product containing this material.
   8 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   9 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
  10 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  11 .TH POSIX_OPENPT 3C "Dec 1, 2003"
  12 .SH NAME
  13 posix_openpt \- open a pseudo terminal device
  14 .SH SYNOPSIS
  15 .LP
  16 .nf
  17 #include <stdlib.h>
  18 #include <fcntl.h>
  19
  20 \fBint\fR \fBposix_openpt\fR(\fBint\fR \fIoflag\fR);
  21 .fi
  22
  23 .SH DESCRIPTION
  24 .sp
  25 .LP
  26 The \fBposix_openpt()\fR function establishes a connection between a master
  27 device for a pseudo-terminal and a file descriptor. The file descriptor is used
  28 by other I/O functions that refer to that pseudo-terminal.
  29 .sp
  30 .LP
  31 The file status flags and file access modes of the open file description are
  32 set according to the value of \fIoflag\fR.
  33 .sp
  34 .LP
  35 Values for \fIoflag\fR are constructed by a bitwise-inclusive OR of flags from
  36 the following list, defined in <\fBfcntl.h\fR>.
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fBO_RDWR\fR\fR
  41 .ad
  42 .RS 12n
  43 Open for reading and writing.
  44 .RE
  45
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fBO_NOCTTY\fR\fR
  50 .ad
  51 .RS 12n
  52 If set, \fBposix_openpt()\fR does not cause the terminal device to become the
  53 controlling terminal for the process.
  54 .RE
  55
  56 .sp
  57 .LP
  58 The behavior of other values for the \fIoflag\fR argument is unspecified.
  59 .SH RETURN VALUES
  60 .sp
  61 .LP
  62 Upon successful completion, the \fBposix_openpt()\fR function opens a master
  63 pseudo-terminal device and returns a non-negative integer representing the
  64 lowest numbered unused file descriptor. Otherwise, -1 is returned and
  65 \fBerrno\fR is set to indicate the error.
  66 .SH ERRORS
  67 .sp
  68 .LP
  69 The \fBposix_openpt()\fR function will fail if:
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fBEMFILE\fR\fR
  74 .ad
  75 .RS 10n
  76 {\fBOPEN_MAX\fR} file descriptors are currently open in the calling process.
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBENFILE\fR\fR
  83 .ad
  84 .RS 10n
  85 The maximum allowable number of files is currently open in the system.
  86 .RE
  87
  88 .sp
  89 .LP
  90 The \fBposix_openpt()\fR function may fail if:
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fBEINVAL\fR\fR
  95 .ad
  96 .RS 10n
  97 The value of \fIoflag\fR is not valid.
  98 .RE
  99
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fBEAGAIN\fR\fR
 104 .ad
 105 .RS 10n
 106 Out of pseudo-terminal resources.
 107 .RE
 108
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fBENOSR\fR\fR
 113 .ad
 114 .RS 10n
 115 Out of STREAMS resources.
 116 .RE
 117
 118 .SH EXAMPLES
 119 .LP
 120 \fBExample 1 \fROpen a pseudo-terminal.
 121 .sp
 122 .LP
 123 The following example opens a pseudo-terminal and returns the name of the slave
 124 device and a file descriptor.
 125
 126 .sp
 127 .in +2
 128 .nf
 129 #include fcntl.h>
 130 #include stdio.h>
 131
 132 int masterfd, slavefd;
 133 char *slavedevice;
 134
 135 masterfd = posix_openpt(O_RDWR|O_NOCTTY);
 136
 137 if (masterfd == -1
 138       || grantpt (masterfd) == -1
 139       || unlockpt (masterfd) == -1
 140       || (slavedevice = ptsname (masterfd)) == NULL)
 141       return -1;
 142
 143 printf("slave device is: %s\en", slavedevice);
 144
 145 slavefd = open(slave, O_RDWR|O_NOCTTY);
 146 if (slavefd < 0)
 147       return -1;
 148 .fi
 149 .in -2
 150
 151 .SH USAGE
 152 .sp
 153 .LP
 154 This function provides a method for portably obtaining a file descriptor of a
 155 master terminal device for a pseudo-terminal. The \fBgrantpt\fR(3C) and
 156 \fBptsname\fR(3C) functions can be used to manipulate mode and ownership
 157 permissions and to obtain the name of the slave device, respectively.
 158 .SH ATTRIBUTES
 159 .sp
 160 .LP
 161 See \fBattributes\fR(5) for descriptions of the following attributes:
 162 .sp
 163
 164 .sp
 165 .TS
 166 box;
 167 c | c
 168 l | l .
 169 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 170 _
 171 Interface Stability     Standard
 172 _
 173 MT-Level        MT-Safe
 174 .TE
 175
 176 .SH SEE ALSO
 177 .sp
 178 .LP
 179 \fBopen\fR(2), \fBgrantpt\fR(3C), \fBptsname\fR(3C), \fBunlockpt\fR(3C),
 180 \fBattributes\fR(5), \fBstandards\fR(5)