.\" 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_RECEIVE" "" "06 October 2005" "" ""

.SH NAME
iucv_receive \- 
.SH SYNOPSIS
"SYNOPSIS"
.sp
\fB
.sp
int iucv_receive  (__u16 \fIpathid\fB, __u32 \fImsgid\fB, __u32 \fItrgcls\fB, void * \fIbuffer\fB, ulong \fIbuflen\fB, int * \fIflags1_out\fB, ulong * \fIresidual_buffer\fB, ulong * \fIresidual_length\fB);
\fR
.SH "ARGUMENTS"
.TP
\fB\fIpathid\fB\fR
Path identification number.
.TP
\fB\fImsgid\fB\fR
Specifies the message ID.
.TP
\fB\fItrgcls\fB\fR
Specifies target class.
.TP
\fB\fIbuffer\fB\fR
Address of buffer to receive. Must be below 2G.
.TP
\fB\fIbuflen\fB\fR
Length of buffer to receive.
.TP
\fB\fIflags1_out\fB\fR
Receives options for path on return.
- IPNORPY (0x10)  Specifies whether a reply is required
- IPPRTY (0x20)   Specifies if you want to send priority message
- IPRMDATA (0x80) Specifies the data is contained in the parameter list
.TP
\fB\fIresidual_buffer\fB\fR
Receives the address of buffer updated by the number
of bytes you have received on return.
.TP
\fB\fIresidual_length\fB\fR
On return, receives one of the following values:
- 0                          If the receive buffer is the same length as
the message.
- Remaining bytes in buffer  If the receive buffer is longer than the
message.
- Remaining bytes in message If the receive buffer is shorter than the
message.
.SH "DESCRIPTION"
.PP
This function receives messages that are being sent to you over established
paths.
.SH "RETURNS"
.PP
return code from CP IUCV call; If the receive buffer is shorter
than the message, always 5
-EINVAL - buffer address is pointing to NULL