usr/src/man/man3dat/dat_pz_create.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_CREATE 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_pz_create \- create 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_create (
  18     IN    DAT_IA_HANDLE    ia_handle,
  19     OUT   DAT_PZ_HANDLE    *pz_handle
  20     )
  21 .fi
  22
  23 .SH PARAMETERS
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fIia_handle\fR\fR
  28 .ad
  29 .RS 13n
  30 Handle for an open instance of the IA.
  31 .RE
  32
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fIpz_handle\fR\fR
  37 .ad
  38 .RS 13n
  39 Handle for the created instance of Protection Zone.
  40 .RE
  41
  42 .SH DESCRIPTION
  43 .sp
  44 .LP
  45 The \fBdat_pz_create()\fR function creates an instance of the Protection Zone.
  46 The Protection Zone provides Consumers a mechanism for association Endpoints
  47 with LMRs and RMRs to provide protection for local and remote memory accesses
  48 by DTOs.
  49 .SH RETURN VALUES
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBDAT_SUCCESS\fR\fR
  54 .ad
  55 .RS 30n
  56 The operation was successful.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBDAT_INSUFFICIENT_RESOURCES\fR\fR
  63 .ad
  64 .RS 30n
  65 The operation failed due to resource limitations.
  66 .RE
  67
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fBDAT_INVALID_PARAMETER\fR\fR
  72 .ad
  73 .RS 30n
  74 Invalid parameter.
  75 .RE
  76
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fBDAT_INVALID_HANDLE\fR\fR
  81 .ad
  82 .RS 30n
  83 The \fIia_handle\fR parameter is invalid.
  84 .RE
  85
  86 .SH ATTRIBUTES
  87 .sp
  88 .LP
  89 See \fBattributes\fR(5) for descriptions of the following attributes:
  90 .sp
  91
  92 .sp
  93 .TS
  94 box;
  95 c | c
  96 l | l .
  97 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  98 _
  99 Interface Stability     Standard: uDAPL, 1.1, 1.2
 100 _
 101 MT-Level        Safe
 102 .TE
 103
 104 .SH SEE ALSO
 105 .sp
 106 .LP
 107 \fBlibdat\fR(3LIB), \fBattributes\fR(5)