Current File : //usr/man/man3dat/dat_cr_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_cr_query 3DAT "16 Jul 2004" "SunOS 5.11" "Direct Access Transport Library Functions"
.SH NAME
dat_cr_query \- provide parameters of the Connection Request
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldat\fR [ \fIlibrary\fR\&.\|.\|. ] 
#include <\fBdat/udat.h\fR>

DAT_RETURN
    dat_cr_query (
    IN    DAT_CR_HANDLE        cr_handle,
    IN    DAT_CR_PARAM_MASK    cr_param_mask,
    OUT   DAT_CR_PARAM         *cr_param
    )
.fi

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIcr_handle\fR\fR
.ad
.RS 17n
.rt  
Handle for an instance of a Connection Request.
.RE

.sp
.ne 2
.mk
.na
\fB\fIcr_param_mask\fR\fR
.ad
.RS 17n
.rt  
Mask for Connection Request parameters.
.RE

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

.SH DESCRIPTION
.sp
.LP
The \fBdat_cr_query()\fR function provides to the Consumer parameters of the Connection Request. The Consumer passes in a pointer to the Consumer-allocated structures for Connection Request parameters that the Provider fills.
.sp
.LP
The \fIcr_param_mask\fR parameter allows Consumers to specify which parameters to query. The Provider returns values for \fIcr_param_mask\fR requested parameters. The Provider can return values for any other parameters.
.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 \fIcr_handle\fR handle is invalid.
.RE

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

.SH USAGE
.sp
.LP
The Consumer uses \fBdat_cr_query()\fR to get information about requesting a remote Endpoint as well as a local Endpoint if it was allocated by the Provider for the arrived Connection Request. The local Endpoint is created if the Consumer used PSP with \fBDAT_PSP_PROVIDER\fR as the value for \fIpsp_flags\fR. For the remote Endpoint, \fBdat_cr_query()\fR  provides \fIremote_ia_address\fR and \fIremote_port_qual\fR. It also provides remote \fIpeer private_data\fR and its size.
.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-LevelSafe
_
StandarduDAPL, 1.1, 1.2
.TE

.SH SEE ALSO
.sp
.LP
\fBlibdat\fR(3LIB), \fBattributes\fR(5)