usr/src/man/man3dat/dat_rmr_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_RMR_QUERY 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_rmr_query \- provide RMR parameters
  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_rmr_query (
  18     IN    DAT_RMR_HANDLE        rmr_handle,
  19     IN    DAT_RMR_PARAM_MASK    rmr_param_mask,
  20     OUT   DAT_RMR_PARAM         *rmr_param
  21     )
  22 .fi
  23
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fIrmr_handle\fR\fR
  29 .ad
  30 .RS 18n
  31 Handle for an instance of the RMR.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIrmr_param_mask\fR\fR
  38 .ad
  39 .RS 18n
  40 Mask for RMR parameters.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fIrmr_param\fR\fR
  47 .ad
  48 .RS 18n
  49 Pointer to a Consumer-allocated structure that the Provider fills with RMR
  50 parameters.
  51 .RE
  52
  53 .SH DESCRIPTION
  54 .sp
  55 .LP
  56 The \fBdat_rmr_query()\fR function provides RMR parameters to the Consumer. The
  57 Consumer passes in a pointer to the Consumer-allocated structures for RMR
  58 parameters that the Provider fills.
  59 .sp
  60 .LP
  61 The \fIrmr_param_mask\fR parameter allows Consumers to specify which parameters
  62 to query. The Provider returns values for \fIrmr_param_mask\fR requested
  63 parameters. The Provider can return values for any other parameters.
  64 .sp
  65 .LP
  66 Not all parameters can have a value at all times. For example,
  67 \fIlmr_handle\fR, \fItarget_address\fR, \fIsegment_length\fR,
  68 \fImem_privileges\fR, and \fIrmr_context\fR are not defined for an unbound RMR.
  69 .SH RETURN VALUES
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fBDAT_SUCCESS\fR\fR
  74 .ad
  75 .RS 25n
  76 The operation was successful.
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBDAT_INVALID_PARAMETER\fR\fR
  83 .ad
  84 .RS 25n
  85 The \fIrmr_param_mask\fR parameter is invalid.
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fBDAT_INVALID_HANDLE\fR\fR
  92 .ad
  93 .RS 25n
  94 The \fImr_handle\fR parameter is invalid.
  95 .RE
  96
  97 .SH ATTRIBUTES
  98 .sp
  99 .LP
 100 See \fBattributes\fR(5) for descriptions of the following attributes:
 101 .sp
 102
 103 .sp
 104 .TS
 105 box;
 106 c | c
 107 l | l .
 108 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 109 _
 110 Interface Stability     Standard: uDAPL, 1.1, 1.2
 111 _
 112 MT-Level        Unsafe
 113 .TE
 114
 115 .SH SEE ALSO
 116 .sp
 117 .LP
 118 \fBlibdat\fR(3LIB), \fBattributes\fR(5)