Current File : //usr/man/man3dat/dat_ep_query.3dat

'\" 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_ep_query 3DAT "16 Jul 2004" "SunOS 5.11" "Direct Access Transport Library Functions"
.SH NAME
dat_ep_query \- provide parameters of the Endpoint
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldat\fR [ \fIlibrary\fR\&.\|.\|. ] 
#include <\fBdat/udat.h\fR>

DAT_RETURN
    dat_ep_query (
    IN    DAT_EP_HANDLE        ep_handle,
    IN    DAT_EP_PARAM_MASK    ep_param_mask,
    OUT   DAT_EP_PARAM         *ep_param
    )
.fi

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIep_handle\fR\fR
.ad
.RS 17n
.rt  
Handle for an instance of the Endpoint.
.RE

.sp
.ne 2
.mk
.na
\fB\fIep_param_mask\fR\fR
.ad
.RS 17n
.rt  
Mask for Endpoint parameters.
.RE

.sp
.ne 2
.mk
.na
\fB\fIep_param\fR\fR
.ad
.RS 17n
.rt  
Pointer to a Consumer-allocated structure that the Provider fills with Endpoint parameters.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBdat_ep_query()\fR function provides the Consumer parameters, including attributes and status, of the Endpoint. Consumers pass in a pointer to Consumer-allocated structures for Endpoint parameters that the Provider fills.
.sp
.LP
The \fIep_param_mask\fR parameter allows Consumers to specify which parameters to query. The Provider returns values for \fIep_param_mask\fR requested parameters. The Provider can return values for any other parameters.
.sp
.LP
Some of the parameters only have values for certain Endpoint states. Specifically, the values for \fIremote_ia_address\fR and \fIremote_port_qual\fR are valid only for Endpoints in the \fBDAT_EP_STATE_PASSIVE_CONNECTION_PENDING\fR, \fBDAT_EP_STATE_ACTIVE_CONNECTION_PENDING\fR, \fBDAT_EP_STATE_TENTATIVE_CONNECTION_PENDING\fR, \fBDAT_EP_STATE_DISCONNECT_PENDING\fR, \fBDAT_EP_STATE_COMPLETION_PENDING\fR, or \fBDAT_EP_STATE_CONNECTED\fR states. The values of \fIlocal_port_qual\fR is valid only for Endpoints in the \fBDAT_EP_STATE_PASSIVE_CONNECTION_PENDING\fR, \fBDAT_EP_STATE_ACTIVE_CONNECTION_PENDING\fR, \fBDAT_EP_STATE_DISCONNECT_PENDING\fR, \fBDAT_EP_STATE_COMPLETION_PENDING\fR, or \fBDAT_EP_STATE_CONNECTED\fR states, and might be valid for \fBDAT_EP_STATE_UNCONNECTED\fR, \fBDAT_EP_STATE_RESERVED\fR, \fBDAT_EP_STATE_TENTATIVE_CONNECTION_PENDING\fR, \fBDAT_EP_STATE_PASSIVE_CONNECTION_PENDING\fR, and \fBDAT_EP_STATE_UNCONNECTED\fR states.
.SH RETURN VALUES
.sp
.ne 2
.mk
.na
\fB\fBDAT_SUCCESS\fR\fR
.ad
.RS 25n
.rt  
The operation was successful.
.RE

.sp
.ne 2
.mk
.na
\fB\fBDAT_INVALID_HANDLE\fR\fR
.ad
.RS 25n
.rt  
The \fIep_handle\fR parameter is invalid.
.RE

.sp
.ne 2
.mk
.na
\fB\fBDAT_INVALID_PARAMETER\fR\fR
.ad
.RS 25n
.rt  
The \fIep_param_mask\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
\fBlibdat\fR(3LIB), \fBattributes\fR(5)