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.
 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.
 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.
 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]
 dat_set_consumer_context 3DAT "16 Jul 2004" "SunOS 5.11" "Direct Access Transport Library Functions"
 NAME
dat_set_consumer_context - set Consumer context
 SYNOPSIS

cc [ flag.\|.\|. ] file.\|.\|. -ldat [ library.\|.\|. ]
#include <dat/udat.h>

DAT_RETURN
 dat_set_consumer_context (
 IN DAT_HANDLE dat_handle,
 IN DAT_CONTEXT context
 )


 PARAMETERS

dat_handle

Handle for a DAT Object associated with context.


context

Consumer context to be stored within the associated dat_handle. The
Consumer context is opaque to the uDAPL Provider. NULL represents no
context.


 DESCRIPTION

The dat_set_consumer_context() function associates a Consumer context
with the specified dat_handle. The dat_handle can be one of the
following handle types: DAT_IA_HANDLE, DAT_EP_HANDLE,
DAT_EVD_HANDLE, DAT_CR_HANDLE, DAT_RSP_HANDLE,
DAT_PSP_HANDLE, DAT_PZ_HANDLE, DAT_LMR_HANDLE,
DAT_RMR_HANDLE, or DAT_CNO_HANDLE.

Only a single Consumer context is provided for any dat_handle. 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 context. The Provider makes
no assumptions about the contents of context; no check is made on its
value. Furthermore, the Provider makes no attempt to provide any
synchronization for access or modification of the context.
 RETURN VALUES

DAT_SUCCESS

The operation was successful.


DAT_INVALID_PARAMETER

The context parameter is invalid.


DAT_INVALID_HANDLE

The dat_handle parameter is invalid.


 ATTRIBUTES

See attributes(5) for descriptions of the following attributes:


ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityStandard: uDAPL, 1.1, 1.2
MT-LevelUnsafe


 SEE ALSO

dat_get_consumer_context(3DAT), libdat(3LIB), attributes(5)

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Interface Stability	Standard: uDAPL, 1.1, 1.2
MT-Level	Unsafe