Content-type: text/html Man page of dat_set_consumer_context

dat_set_consumer_context

Section: Direct Access Transport Library Functions (3DAT)
Updated: 16 Jul 2004
Index Return to Main Contents
 

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)


 

Index

NAME
SYNOPSIS
PARAMETERS
DESCRIPTION
RETURN VALUES
ATTRIBUTES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 02:40:02 GMT, October 02, 2010