.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "IUCV_CONNECT" "" "06 October 2005" "" ""

.SH NAME
iucv_connect \- 
.SH SYNOPSIS
"SYNOPSIS"
.sp
\fB
.sp
int iucv_connect  (__u16 * \fIpathid\fB, __u16 \fImsglim_reqstd\fB, __u8 * \fIuser_data\fB, __u8 * \fIuserid\fB, __u8 * \fIsystem_name\fB, int \fIflags1\fB, int * \fIflags1_out\fB, __u16 * \fImsglim\fB, iucv_handle_t \fIhandle\fB, void * \fIpgm_data\fB);
\fR
.SH "ARGUMENTS"
.TP
\fB\fIpathid\fB\fR
Path identification number
.TP
\fB\fImsglim_reqstd\fB\fR
Number of outstanding messages requested
.TP
\fB\fIuser_data\fB\fR
16-byte user data
.TP
\fB\fIuserid\fB\fR
8-byte of user identification
.TP
\fB\fIsystem_name\fB\fR
8-byte identifying the system name
.TP
\fB\fIflags1\fB\fR
Specifies options for this path:
- IPPRTY (0x20)   Specifies if you want to send priority message.
- IPRMDATA (0x80) Specifies whether your program can handle a message
in  the parameter list.
- IPQUSCE (0x40)  Specifies whether you want to quiesce the path being
established.
- IPLOCAL (0x01)  Allows an application to force the partner to be on the
local system. If local is specified then target class
cannot be specified.
.TP
\fB\fIflags1_out\fB\fR
Pointer to an int. If not NULL, on return the options for
.TP
\fB\fImsglim\fB\fR
Pointer to an __u16. If not NULL, on return the maximum
number of outstanding messages is stored at the given
location.
.TP
\fB\fIhandle\fB\fR
Address of handler.
.TP
\fB\fIpgm_data\fB\fR
Application data to be passed to interrupt handlers.
.SH "THE PATH ARE STORED AT THE GIVEN LOCATION"
.PP
- IPPRTY (0x20)   Indicates you may send a priority message.
.SH "DESCRIPTION"
.PP
This function establishes an IUCV path. Although the connect may complete
successfully, you are not able to use the path until you receive an IUCV
Connection Complete external interrupt.
.SH "RETURNS"
.PP
return code from CP, or one of the following
- ENOMEM
- return code from iucv_declare_buffer
- EINVAL - invalid handle passed by application
- EINVAL - pathid address is NULL
- ENOMEM - pathid table storage allocation failed
- return code from internal function add_pathid