share/man/man3c/door_revoke.3c

   1 '\" te
   2 .\" Copyright (c) 2005, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH DOOR_REVOKE 3C "Mar 22, 2005"
   7 .SH NAME
   8 door_revoke \- revoke access to a door descriptor
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR \fB-mt\fR [ \fIflag\fR... ] \fIfile\fR... [ \fIlibrary\fR... ]
  13 #include <door.h>
  14
  15 \fBint\fR \fBdoor_revoke\fR(\fBint\fR \fId\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .LP
  20 The \fBdoor_revoke()\fR function revokes access to a door descriptor. Door
  21 descriptors are created with \fBdoor_create\fR(3C). The \fBdoor_revoke()\fR
  22 function performs an implicit call to \fBclose\fR(2), marking the door
  23 descriptor \fId\fR as invalid.
  24 .sp
  25 .LP
  26 A door descriptor can be revoked only by the process that created it. Door
  27 invocations that are in progress during a \fBdoor_revoke()\fR invocation are
  28 allowed to complete normally.
  29 .SH RETURN VALUES
  30 .LP
  31 Upon successful completion, \fBdoor_revoke()\fR returns \fB0\fR. Otherwise,
  32 \fBdoor_revoke()\fR returns \(mi1 and sets \fBerrno\fR to indicate the error.
  33 .SH ERRORS
  34 .LP
  35 The \fBdoor_revoke()\fR function will fail if:
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fBEBADF\fR\fR
  40 .ad
  41 .RS 9n
  42 An invalid door descriptor was passed.
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fBEPERM\fR\fR
  49 .ad
  50 .RS 9n
  51 The door descriptor was not created by this process (with
  52 \fBdoor_create\fR(3C)).
  53 .RE
  54
  55 .SH ATTRIBUTES
  56 .LP
  57 See \fBattributes\fR(5) for descriptions of the following attributes:
  58 .sp
  59
  60 .sp
  61 .TS
  62 box;
  63 c | c
  64 l | l .
  65 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  66 _
  67 Architecture    all
  68 _
  69 Interface Stability     Stable
  70 _
  71 MT-Level        Safe
  72 .TE
  73
  74 .SH SEE ALSO
  75 .LP
  76 \fBclose\fR(2), \fBdoor_create\fR(3C), \fBattributes\fR(5)