usr/src/man/man3dat/dat_get_consumer_context.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_GET_CONSUMER_CONTEXT 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_get_consumer_context \- get Consumer context
  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_get_consumer_context (
  18     IN    DAT_HANDLE    \fIdat_handle\fR,
  19     OUT   DAT_CONTEXT   *\fIcontext\fR
  20     )
  21 .fi
  22
  23 .SH PARAMETERS
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fIdat_handle\fR\fR
  28 .ad
  29 .RS 14n
  30 Handle for a DAT Object associated with \fIcontext\fR.
  31 .RE
  32
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fIcontext\fR\fR
  37 .ad
  38 .RS 14n
  39 Pointer to Consumer-allocated storage where the current value of the
  40 \fIdat_handle\fR context will be stored.
  41 .RE
  42
  43 .SH DESCRIPTION
  44 .sp
  45 .LP
  46 The \fBdat_get_consumer_context()\fR function gets the Consumer context from
  47 the specified \fIdat_handle\fR. The \fIdat_handle\fR can be one of the
  48 following handle types: \fBDAT_IA_HANDLE\fR, \fBDAT_EP_HANDLE\fR,
  49 \fBDAT_EVD_HANDLE\fR, \fBDAT_CR_HANDLE\fR, \fBDAT_RSP_HANDLE\fR,
  50 \fBDAT_PSP_HANDLE\fR, \fBDAT_PZ_HANDLE\fR, \fBDAT_LMR_HANDLE\fR,
  51 \fBDAT_RMR_HANDLE\fR, or \fBDAT_CNO_HANDLE\fR.
  52 .SH RETURN VALUES
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fBDAT_SUCCESS\fR\fR
  57 .ad
  58 .RS 22n
  59 The operation was successful. The Consumer context was successfully retrieved
  60 from the specified handle.
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBDAT_INVALID_HANDLE\fR\fR
  67 .ad
  68 .RS 22n
  69 The \fIdat_handle\fR parameter is invalid.
  70 .RE
  71
  72 .SH ATTRIBUTES
  73 .sp
  74 .LP
  75 See \fBattributes\fR(5) for descriptions of the following attributes:
  76 .sp
  77
  78 .sp
  79 .TS
  80 box;
  81 c | c
  82 l | l .
  83 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  84 _
  85 Interface Stability     Standard: uDAPL, 1.1, 1.2
  86 _
  87 MT-Level        Unsafe
  88 .TE
  89
  90 .SH SEE ALSO
  91 .sp
  92 .LP
  93 \fBdat_set_consumer_context\fR(3DAT), \fBlibdat\fR(3LIB), \fBattributes\fR(5)