usr/src/man/man3dat/dat_set_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_SET_CONSUMER_CONTEXT 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_set_consumer_context \- set 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_set_consumer_context (
  18     IN    DAT_HANDLE    \fIdat_handle\fR,
  19     IN    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 Consumer context to be stored within the associated \fIdat_handle\fR. The
  40 Consumer context is opaque to the uDAPL Provider. \fINULL\fR represents no
  41 context.
  42 .RE
  43
  44 .SH DESCRIPTION
  45 .sp
  46 .LP
  47 The \fBdat_set_consumer_context()\fR function associates a Consumer context
  48 with the specified \fIdat_handle\fR. The \fIdat_handle\fR can be one of the
  49 following handle types: \fBDAT_IA_HANDLE\fR, \fBDAT_EP_HANDLE\fR,
  50 \fBDAT_EVD_HANDLE\fR, \fBDAT_CR_HANDLE\fR, \fBDAT_RSP_HANDLE\fR,
  51 \fBDAT_PSP_HANDLE\fR, \fBDAT_PZ_HANDLE\fR, \fBDAT_LMR_HANDLE\fR,
  52 \fBDAT_RMR_HANDLE\fR, or \fBDAT_CNO_HANDLE\fR.
  53 .sp
  54 .LP
  55 Only a single Consumer context is provided for any \fIdat_handle\fR. If there
  56 is a previous Consumer context associated with the specified handle, the new
  57 context replaces the old one. The Consumer can disassociate the existing
  58 context by providing a NULL pointer for the \fIcontext\fR. The Provider makes
  59 no assumptions about the contents of \fIcontext\fR; no check is made on its
  60 value. Furthermore, the Provider makes no attempt to provide any
  61 synchronization for access or modification of the \fIcontext\fR.
  62 .SH RETURN VALUES
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBDAT_SUCCESS\fR\fR
  67 .ad
  68 .RS 25n
  69 The operation was successful.
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBDAT_INVALID_PARAMETER\fR\fR
  76 .ad
  77 .RS 25n
  78 The \fIcontext\fR parameter is invalid.
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBDAT_INVALID_HANDLE\fR\fR
  85 .ad
  86 .RS 25n
  87 The \fIdat_handle\fR parameter is invalid.
  88 .RE
  89
  90 .SH ATTRIBUTES
  91 .sp
  92 .LP
  93 See \fBattributes\fR(5) for descriptions of the following attributes:
  94 .sp
  95
  96 .sp
  97 .TS
  98 box;
  99 c | c
 100 l | l .
 101 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 102 _
 103 Interface Stability     Standard: uDAPL, 1.1, 1.2
 104 _
 105 MT-Level        Unsafe
 106 .TE
 107
 108 .SH SEE ALSO
 109 .sp
 110 .LP
 111 \fBdat_get_consumer_context\fR(3DAT), \fBlibdat\fR(3LIB), \fBattributes\fR(5)