← Back to branch summary

~ubuntu-branches/ubuntu/intrepid/curl/intrepid

« back to all changes in this revision

Viewing changes to docs/libcurl/curl_multi_info_read.3

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2007-05-16 15:16:54 UTC
  • mfrom: (1.1.7 upstream)
  • Revision ID: james.westby@ubuntu.com-20070516151654-jo48r81zempo1qav
Tags: 7.16.2-3ubuntu1
* Merge with Debian; remaining changes:
  - Drop the stunnel build dependency.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/libcurl/curl_multi_info_read.3
1
 
.\" $Id: curl_multi_info_read.3,v 1.5 2004/12/18 10:24:49 bagder Exp $
 
1
.\" $Id: curl_multi_info_read.3,v 1.8 2006-12-31 13:53:19 bagder Exp $
2
2
.\"
3
3
.TH curl_multi_info_read 3 "18 Dec 2004" "libcurl 7.10.3" "libcurl Manual"
4
4
.SH NAME
20
20
integer pointed to with \fImsgs_in_queue\fP will contain the number of
21
21
remaining messages after this function was called.
22
22
 
 
23
When you fetch a message using this function, it is removed from the internal
 
24
queue so calling this function again will not return the same message
 
25
again. It will instead return new messages at each new invoke until the queue
 
26
is emptied.
 
27
 
23
28
The data the returned pointer points to will not survive calling
24
 
\fIcurl_multi_cleanup(3)\fP or \fIcurl_multi_remove_handle(3)\fP.
 
29
\fIcurl_multi_cleanup(3)\fP, \fIcurl_multi_remove_handle(3)\fP or
 
30
\fIcurl_easy_cleanup(3)\fP.
25
31
 
26
32
The 'CURLMsg' struct is very simple and only contain very basic information.
27
33
If more involved information is wanted, the particular "easy handle" in
37
43
     CURLcode result;   /* return code for transfer */
38
44
   } data;
39
45
 };
 
46
 
 
47
When \fBmsg\fP is \fICURLMSG_DONE\fP, the message identifies a transfer that
 
48
is done, and then \fBresult\fP contains the return code for the easy handle
 
49
that just completed.
 
50
 
 
51
At this point, there is no other \fBmsg\fP types defined.
40
52
.SH "RETURN VALUE"
41
53
A pointer to a filled-in struct, or NULL if it failed or ran out of
42
54
structs. It also writes the number of messages left in the queue (after this