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(5) for descriptions of the following attributes:

See Also

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