NS/main/source/curl/docs/libcurl/curl_multi_info_read.html
Karl 8552ac617c Import from old repository
git-svn-id: https://unknownworlds.svn.cloudforge.com/ns1@1 67975925-1194-0748-b3d5-c16f83f1a3a1
2005-03-09 01:31:56 +00:00

72 lines
2.3 KiB
HTML

<HTML>
<BODY>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->
curl_multi_info_read - read multi stack informationals
</PRE>
<H2>SYNOPSIS</H2><PRE>
#include &lt;curl/curl.h&gt;
CURLMsg *curl_multi_info_read( CURLM *multi_handle,
int *msgs_in_queue);
</PRE>
<H2>DESCRIPTION</H2><PRE>
Ask the multi handle if there are any messages/informa-
tionals from the individual transfers. Messages may
include informationals such as an error code from the
transfer or just the fact that a transfer is completed.
More details on these should be written down as well.
Repeated calls to this function will return a new struct
each time, until a NULL is returned as a signal that there
is no more to get at this point. The integer pointed to
with <I>msgs</I><B>_</B><I>in</I><B>_</B><I>queue</I> will contain the number of remaining
messages after this function was called.
The data the returned pointer points to will not survive
calling curl_multi_cleanup().
The 'CURLMsg' struct is very simple and only contain very
basic informations. If more involved information is
wanted, the particular "easy handle" in present in that
struct and can thus be used in subsequent regular
curl_easy_getinfo() calls (or similar):
struct CURLMsg {
CURLMSG msg; /* what this message means */
CURL *easy_handle; /* the handle it concerns */
union {
void *whatever; /* message-specific data */
CURLcode result; /* return code for transfer */
} data;
};
</PRE>
<H2>RETURN VALUE</H2><PRE>
A pointer to a filled-in struct, or NULL if it failed or
ran out of structs. It also writes the number of messages
left in the queue (after this read) in the integer the
second argument points to.
</PRE>
<H2>SEE ALSO</H2><PRE>
<B>curl_multi_cleanup(3)</B>, <B>curl_multi_init(3)</B>, <B>curl_multi_per-</B>
<B>form(3)</B>
</PRE>
<HR>
<ADDRESS>
Man(1) output converted with
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
</ADDRESS>
</BODY>
</HTML>