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