.\" @(#)PEXFetchElementsAndSend.3 1.5 95/03/24 SMI;
.so man3/pex.macs
.TH PEXFetchElementsAndSend 3 "May 1995" "Solaris PEXlib Reference Manual" ""
.SH NAME
PEXFetchElementsAndSend - Fetch Elements and Send to Display
.SH SYNTAX
.HP
Status PEXFetchElementsAndSend\^(\^Display *\fIsrc_display\fP\^, PEXStructure \fIstructure\fP\^, int \fIwhence1\fP\^, long \fIoffset1\fP\^, int \fIwhence2\fP\^, long \fIoffset2\fP\^, Display *\fIdst_display\fP\^, XID \fIresource_id\fP\^, PEXOCRequestType \fIreq_type\fP\^)
.SH PARAMETERS
.TP 1i
\fIdisplay\fP
A pointer to a display structure returned by a successful
.B XOpenDisplay
call.
.IP \fIstructure\fP 1i
The resource identifier of the structure.
.IP \fIwhence1\fP 1i
A value specifying, with \fIoffset1\fP, the first limit of the range of
elements to be fetched (
.B PEXBeginning,
.B PEXCurrent,
.B PEXEnd
).
.IP \fIoffset1\fP 1i
The offset from \fIwhence1\fP denoting the first limit of the range of
elements to be fetched.
.IP \fIwhence2\fP 1i
A value specifying, with \fIoffset2\fP, the second limit of the range of
elements to be fetched (
.B PEXBeginning,
.B PEXCurrent,
.B PEXEnd
).
.IP \fIoffset2\fP 1i
The offset from \fIwhence2\fP denoting the second limit of the range of
elements to be fetched.
.IP \fIdst_display\fP 1i
A pointer to a display structure returned by a successful
.B XOpenDisplay
call.
.IP \fIresource_id\fP 1i
The resource identifier of the renderer or structure.
.IP \fIreq_type\fP 1i
The request type for the output commands (
.B PEXOCRender,
.B PEXOCStore,
.B PEXOCRenderSingle
or
.B PEXOCStoreSingle
).
.SH RETURNS
Zero if unsuccessful, non-zero otherwise.
.SH DESCRIPTION
.\" indexing
.IX PEXFetchElementsAndSend
.IX "Structure Elements" PEXFetchElementsAndSend
.LP
This function is like
.BR PEXFetchElements (3)
except that the list of output commands are not returned to the application
but are sent directly to the specified destination display.
.LP
Calling this function is similar to calling
.BR PEXFetchElements (3) ,
and then sending the returned list of output commands by calling
.BR PEXStartOC (3) ,
.BR PEXCopyBytesToOC (3)
and
.BR PEXFinishOCs (3) .
.LP
If the destination display does not support the same floating point format
as the format PEXlib is using with the source display, and if PEXlib can not
convert to a format supported by the destination display, the function will
return unsuccessfully.
.LP
Sending output commands to a
.I structure
whose editing mode is
.B PEXStructureReplace,
is not really useful.  The behavior will be unpredictable
unless a request type of
.B PEXOCStoreSingle
is used.  And, if the request type is
.B PEXOCStoreSingle,
each output command will simply replace the previous one sent.
Applications should ensure that the structure's editing mode is
.B PEXStructureInsert,
when sending multiple output commands.  If it is intended to replace multiple
elements, the application can delete those elements first, and then insert the
new ones.
.SH DATA STRUCTURES
.LP
.nf
typedef  XID	PEXStructure;
.fi
.sp
.SH ERRORS
.TP
.SB BadPEXStructure
The specified
.I structure
resource identifier is invalid.
.TP
.SB BadValue
The specified value for whence parameter is invalid.
.SH SEE ALSO
.LP
.nf
.BR PEXFetchElements (3)
.fi