DAT_GET_CONSUMER_CONTEXT(3DAT) Direct Access Transport Library Functions
dat_get_consumer_context - get Consumer context
cc [ flag... ] file... -ldat [ library... ]
#include <dat/udat.h>
DAT_RETURN
dat_get_consumer_context (
IN DAT_HANDLE dat_handle,
OUT DAT_CONTEXT *context
)
dat_handle
Handle for a DAT Object associated with context.
context
Pointer to Consumer-allocated storage where the current
value of the dat_handle context will be stored.
The dat_get_consumer_context() function gets the Consumer context
from 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.
DAT_SUCCESS
The operation was successful. The Consumer
context was successfully retrieved from the
specified handle.
DAT_INVALID_HANDLE
The dat_handle parameter is invalid.
See attributes(7) for descriptions of the following attributes:
+--------------------+---------------------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+---------------------------+
|Interface Stability | Standard: uDAPL, 1.1, 1.2 |
+--------------------+---------------------------+
|MT-Level | Unsafe |
+--------------------+---------------------------+
dat_set_consumer_context(3DAT), libdat(3LIB), attributes(7)
July 16, 2004 DAT_GET_CONSUMER_CONTEXT(3DAT)
NAME
dat_get_consumer_context - get Consumer context
SYNOPSIS
cc [ flag... ] file... -ldat [ library... ]
#include <dat/udat.h>
DAT_RETURN
dat_get_consumer_context (
IN DAT_HANDLE dat_handle,
OUT DAT_CONTEXT *context
)
PARAMETERS
dat_handle
Handle for a DAT Object associated with context.
context
Pointer to Consumer-allocated storage where the current
value of the dat_handle context will be stored.
DESCRIPTION
The dat_get_consumer_context() function gets the Consumer context
from 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.
RETURN VALUES
DAT_SUCCESS
The operation was successful. The Consumer
context was successfully retrieved from the
specified handle.
DAT_INVALID_HANDLE
The dat_handle parameter is invalid.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+--------------------+---------------------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+---------------------------+
|Interface Stability | Standard: uDAPL, 1.1, 1.2 |
+--------------------+---------------------------+
|MT-Level | Unsafe |
+--------------------+---------------------------+
SEE ALSO
dat_set_consumer_context(3DAT), libdat(3LIB), attributes(7)
July 16, 2004 DAT_GET_CONSUMER_CONTEXT(3DAT)