xref: /illumos-gate/usr/src/man/man3dat/dat_get_consumer_context.3dat (revision 2bbdd445a21f9d61f4a0ca0faf05d5ceb2bd91f3)
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_GET_CONSUMER_CONTEXT 3DAT "Jul 16, 2004"
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(5) 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(5)