usr/src/man/man3dat/dat_pz_free.3dat

   1 '\" te
   2 .\" This manual page is derived from the DAT/uDAPL 1.2 specification.
   3 .\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH DAT_PZ_FREE 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_pz_free \- destroy an instance of the Protection Zone
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldat\fR [ \fIlibrary\fR\&.\|.\|. ]
  14 #include <\fBdat/udat.h\fR>
  15
  16 DAT_RETURN
  17     dat_pz_free (
  18     IN    DAT_PZ_HANDLE    pz_handle
  19     )
  20 .fi
  21
  22 .SH PARAMETERS
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fIpz_handle\fR\fR
  27 .ad
  28 .RS 13n
  29 Handle for an instance of Protection Zone to be destroyed.
  30 .RE
  31
  32 .SH DESCRIPTION
  33 .sp
  34 .LP
  35 The \fBdat_pz_free()\fR function destroys an instance of the Protection Zone.
  36 The Protection Zone cannot be destroyed if it is in use by an Endpoint, LMR, or
  37 RMR.
  38 .sp
  39 .LP
  40 Use of the handle of the destroyed Protection Zone in any subsequent operation
  41 except for \fBdat_pz_free()\fR fails.
  42 .SH RETURN VALUES
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fBDAT_SUCCESS\fR\fR
  47 .ad
  48 .RS 22n
  49 The operation was successful.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fBDAT_INVALID_STATE\fR\fR
  56 .ad
  57 .RS 22n
  58 Parameter in an invalid state. The Protection Zone was in use by Endpoint, LMR,
  59 or RMR instances.
  60 .RE
  61
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fBDAT_INVALID_HANDLE\fR\fR
  66 .ad
  67 .RS 22n
  68 The \fIpz_handle\fR parameter is invalid.
  69 .RE
  70
  71 .SH ATTRIBUTES
  72 .sp
  73 .LP
  74 See \fBattributes\fR(5) for descriptions of the following attributes:
  75 .sp
  76
  77 .sp
  78 .TS
  79 box;
  80 c | c
  81 l | l .
  82 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  83 _
  84 Interface Stability     Standard: uDAPL, 1.1, 1.2
  85 _
  86 MT-Level        Unsafe
  87 .TE
  88
  89 .SH SEE ALSO
  90 .sp
  91 .LP
  92 \fBlibdat\fR(3LIB), \fBattributes\fR(5)