usr/src/man/man3dat/dat_pz_query.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_QUERY 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_pz_query \- provides parameters 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_query (
  18     IN    DAT_PZ_HANDLE        pz_handle,
  19     IN    DAT_PZ_PARAM_MASK    pz_param_mask,
  20     OUT   DAT_PZ_PARAM         *pz_param
  21     )
  22 .fi
  23
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fIpz_handle:\fR\fR
  29 .ad
  30 .RS 18n
  31 Handle for the created instance of the Protection Zone.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIpz_param_mask:\fR\fR
  38 .ad
  39 .RS 18n
  40 Mask for Protection Zone parameters.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fIpz_param:\fR\fR
  47 .ad
  48 .RS 18n
  49 Pointer to a Consumer-allocated structure that the Provider fills with
  50 Protection Zone parameters.
  51 .RE
  52
  53 .SH DESCRIPTION
  54 .sp
  55 .LP
  56 The \fBdat_pz_query()\fR function provides the Consumer parameters of the
  57 Protection Zone. The Consumer passes in a pointer to the Consumer-allocated
  58 structures for Protection Zone parameters that the Provider fills.
  59 .sp
  60 .LP
  61 The \fIpz_param_mask\fR parameter allows Consumers to specify which parameters
  62 to query. The Provider returns values for \fIpz_param_mask\fR requested
  63 parameters. The Provider can return values for any other parameters.
  64 .SH RETURN VALUES
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fBDAT_SUCCESS\fR\fR
  69 .ad
  70 .RS 25n
  71 The operation was successful.
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fBDAT_INVALID_PARAMETER\fR\fR
  78 .ad
  79 .RS 25n
  80 The \fIpz_param_mask\fR parameter is invalid.
  81 .RE
  82
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fBDAT_INVALID_HANDLE\fR\fR
  87 .ad
  88 .RS 25n
  89 The \fIpz_handle\fR parameter is invalid.
  90 .RE
  91
  92 .SH ATTRIBUTES
  93 .sp
  94 .LP
  95 See \fBattributes\fR(5) for descriptions of the following attributes:
  96 .sp
  97
  98 .sp
  99 .TS
 100 box;
 101 c | c
 102 l | l .
 103 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 104 _
 105 Interface Stability     Standard: uDAPL, 1.1, 1.2
 106 _
 107 MT-Level        Safe
 108 .TE
 109
 110 .SH SEE ALSO
 111 .sp
 112 .LP
 113 \fBlibdat\fR(3LIB), \fBattributes\fR(5)