docs/libcurl/curl_multi_add_handle.3

   1 .\" $Id$
   2 .\"
   3 .TH curl_multi_add_handle 3 "4 March 2002" "libcurl 7.9.5" "libcurl Manual"
   4 .SH NAME
   5 curl_multi_add_handle - add an easy handle to a multi session
   6 .SH SYNOPSIS
   7 #include <curl/curl.h>
   8
   9 CURLMcode curl_multi_add_handle(CURLM *multi_handle, CURL *easy_handle);
  10 .ad
  11 .SH DESCRIPTION
  12 Adds a standard easy handle to the multi stack. This function call will make
  13 this \fImulti_handle\fP control the specified \fIeasy_handle\fP.
  14
  15 When an easy handle has been added to a multi stack, you can not and you must
  16 not use \fIcurl_easy_perform(3)\fP on that handle!
  17
  18 If the easy handle is not set to use a shared (CURLOPT_SHARE) or global DNS
  19 cache (CURLOPT_DNS_USE_GLOBAL_CACHE), it will be made to use the DNS cache
  20 that is shared between all easy handles within the multi handle when
  21 \fIcurl_multi_add_handle(3)\fP is called.
  22
  23 The easy handle will remain added until you remove it again with
  24 \fIcurl_multi_remove_handle(3)\fP. You should remove the easy handle from the
  25 multi stack before you terminate first the easy handle and then the multi
  26 handle:
  27
  28 1 - \fIcurl_multi_remove_handle(3)\fP
  29
  30 2 - \fIcurl_easy_cleanup(3)\fP
  31
  32 3 - \fIcurl_multi_cleanup(3)\fP
  33 .SH RETURN VALUE
  34 CURLMcode type, general libcurl multi interface error code.
  35 .SH "SEE ALSO"
  36 .BR curl_multi_cleanup "(3)," curl_multi_init "(3)"