'\" te .\" This manual page is derived from the DAT/uDAPL 1.2 specification. .\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved. .TH dat_get_consumer_context 3DAT "16 Jul 2004" "SunOS 5.11" "Direct Access Transport Library Functions" .SH NAME dat_get_consumer_context \- get Consumer context .SH SYNOPSIS .LP .nf cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldat\fR [ \fIlibrary\fR\&.\|.\|. ] #include <\fBdat/udat.h\fR> DAT_RETURN dat_get_consumer_context ( IN DAT_HANDLE \fIdat_handle\fR, OUT DAT_CONTEXT *\fIcontext\fR ) .fi .SH PARAMETERS .sp .ne 2 .mk .na \fB\fIdat_handle\fR\fR .ad .RS 14n .rt Handle for a DAT Object associated with \fIcontext\fR. .RE .sp .ne 2 .mk .na \fB\fIcontext\fR\fR .ad .RS 14n .rt Pointer to Consumer-allocated storage where the current value of the \fIdat_handle\fR context will be stored. .RE .SH DESCRIPTION .sp .LP The \fBdat_get_consumer_context()\fR function gets the Consumer context from the specified \fIdat_handle\fR. The \fIdat_handle\fR can be one of the following handle types: \fBDAT_IA_HANDLE\fR, \fBDAT_EP_HANDLE\fR, \fBDAT_EVD_HANDLE\fR, \fBDAT_CR_HANDLE\fR, \fBDAT_RSP_HANDLE\fR, \fBDAT_PSP_HANDLE\fR, \fBDAT_PZ_HANDLE\fR, \fBDAT_LMR_HANDLE\fR, \fBDAT_RMR_HANDLE\fR, or \fBDAT_CNO_HANDLE\fR. .SH RETURN VALUES .sp .ne 2 .mk .na \fB\fBDAT_SUCCESS\fR\fR .ad .RS 22n .rt The operation was successful. The Consumer context was successfully retrieved from the specified handle. .RE .sp .ne 2 .mk .na \fB\fBDAT_INVALID_HANDLE\fR\fR .ad .RS 22n .rt The \fIdat_handle\fR parameter is invalid. .RE .SH ATTRIBUTES .sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp .sp .TS tab() box; cw(2.75i) |cw(2.75i) lw(2.75i) |lw(2.75i) . ATTRIBUTE TYPEATTRIBUTE VALUE _ Interface StabilityCommitted _ MT-LevelUnsafe _ StandarduDAPL, 1.1, 1.2 .TE .SH SEE ALSO .sp .LP \fBdat_set_consumer_context\fR(3DAT), \fBlibdat\fR(3LIB), \fBattributes\fR(5)