Current File : //usr/man/man3dat/dat_set_consumer_context.3dat

'\" te
.\" This manual page is derived from the DAT/uDAPL 1.2 specification.
.\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
.TH dat_set_consumer_context 3DAT "16 Jul 2004" "SunOS 5.11" "Direct Access Transport Library Functions"
.SH NAME
dat_set_consumer_context \- set Consumer context
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldat\fR [ \fIlibrary\fR\&.\|.\|. ] 
#include <\fBdat/udat.h\fR>

DAT_RETURN
    dat_set_consumer_context (
    IN    DAT_HANDLE    \fIdat_handle\fR,
    IN    DAT_CONTEXT   \fIcontext\fR
    )
.fi

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIdat_handle\fR\fR
.ad
.RS 14n
.rt  
Handle for a DAT Object associated with \fIcontext\fR.
.RE

.sp
.ne 2
.mk
.na
\fB\fIcontext\fR\fR
.ad
.RS 14n
.rt  
Consumer context to be stored within the associated \fIdat_handle\fR. The Consumer context is opaque to the uDAPL Provider. \fINULL\fR represents no context.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBdat_set_consumer_context()\fR function associates a Consumer context with the specified \fIdat_handle\fR. The \fIdat_handle\fR can be one of the following handle types: \fBDAT_IA_HANDLE\fR, \fBDAT_EP_HANDLE\fR, \fBDAT_EVD_HANDLE\fR, \fBDAT_CR_HANDLE\fR, \fBDAT_RSP_HANDLE\fR, \fBDAT_PSP_HANDLE\fR, \fBDAT_PZ_HANDLE\fR, \fBDAT_LMR_HANDLE\fR, \fBDAT_RMR_HANDLE\fR, or \fBDAT_CNO_HANDLE\fR.
.sp
.LP
Only a single Consumer context is provided for any \fIdat_handle\fR. If there is a previous Consumer context associated with the specified handle, the new context replaces the old one. The Consumer can disassociate the existing context by providing a NULL pointer for the \fIcontext\fR. The Provider makes no assumptions about the contents of \fIcontext\fR; no check is made on its value. Furthermore, the Provider makes no attempt to provide any synchronization for access or modification of the \fIcontext\fR.
.SH RETURN VALUES
.sp
.ne 2
.mk
.na
\fB\fBDAT_SUCCESS\fR\fR
.ad
.RS 25n
.rt  
The operation was successful.
.RE

.sp
.ne 2
.mk
.na
\fB\fBDAT_INVALID_PARAMETER\fR\fR
.ad
.RS 25n
.rt  
The \fIcontext\fR parameter is invalid.
.RE

.sp
.ne 2
.mk
.na
\fB\fBDAT_INVALID_HANDLE\fR\fR
.ad
.RS 25n
.rt  
The \fIdat_handle\fR parameter is invalid.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelUnsafe
_
StandarduDAPL, 1.1, 1.2
.TE

.SH SEE ALSO
.sp
.LP
\fBdat_get_consumer_context\fR(3DAT), \fBlibdat\fR(3LIB), \fBattributes\fR(5)