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

   1 '\" te
   2 .\" Copyright (c) 1997, The Open Group. All Rights Reserved.
   3 .\" Copyright 1989 AT&T
   4 .\" Portions Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.
   5 .\" 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
   6 .\" http://www.opengroup.org/bookstore/.
   7 .\" 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.
   8 .\"  This notice shall appear on any product containing this material.
   9 .\" 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.
  10 .\" 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.
  11 .\" 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]
  12 .TH UNLOCKPT 3C "Aug 14, 2002"
  13 .SH NAME
  14 unlockpt \- unlock a pseudo-terminal master/slave pair
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 #include <stdlib.h>
  19
  20 \fBint\fR \fBunlockpt\fR(\fBint\fR \fIfildes\fR);
  21 .fi
  22
  23 .SH DESCRIPTION
  24 .sp
  25 .LP
  26 The \fBunlockpt()\fR function unlocks the slave pseudo-terminal device
  27 associated with the master to which \fIfildes\fR refers.
  28 .sp
  29 .LP
  30 Portable applications must call \fBunlockpt()\fR before opening the slave side
  31 of a pseudo-terminal device.
  32 .SH RETURN VALUES
  33 .sp
  34 .LP
  35 Upon successful completion, \fBunlockpt()\fR returns \fB0\fR. Otherwise, it
  36 returns \fB\(mi1\fR and sets \fBerrno\fR to indicate the error.
  37 .SH ERRORS
  38 .sp
  39 .LP
  40 The \fBunlockpt()\fR function may fail if:
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fBEBADF\fR\fR
  45 .ad
  46 .RS 10n
  47 The \fIfildes\fR argument is not a file descriptor open for writing.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBEINVAL\fR\fR
  54 .ad
  55 .RS 10n
  56 The \fIfildes\fR argument is not associated with a master pseudo-terminal
  57 device.
  58 .RE
  59
  60 .SH ATTRIBUTES
  61 .sp
  62 .LP
  63 See \fBattributes\fR(5) for descriptions of the following attributes:
  64 .sp
  65
  66 .sp
  67 .TS
  68 box;
  69 c | c
  70 l | l .
  71 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  72 _
  73 Interface Stability     Standard
  74 _
  75 MT-Level        Safe
  76 .TE
  77
  78 .SH SEE ALSO
  79 .sp
  80 .LP
  81 \fBopen\fR(2), \fBgrantpt\fR(3C), \fBptsname\fR(3C), \fBattributes\fR(5),
  82 \fBstandards\fR(5)
  83 .sp
  84 .LP
  85 \fISTREAMS Programming Guide\fR