.. include:: ../global.rst

.. idio:currentmodule:: libcurl

libcurl Functions
-----------------

.. _`libcurl/curl-version`:

.. idio:function:: libcurl/curl-version


   Return the libcurl version	
   				
   :return: libcurl version	
   :rtype: string			


.. _`libcurl/curl-easy-init`:

.. idio:function:: libcurl/curl-easy-init


   Return a libcurl easy handle	
   				
   :return: :ref:`libcurl/CURL <libcurl/CURL>`	
   :rtype: C/pointer		
   :raises ^rt-libcurl-error:	


.. _`libcurl/curl-easy-setopt`:

.. idio:function:: libcurl/curl-easy-setopt curl [kw arg]+


   set libcurl easy options on `curl`	
   					
   :param curl: libcurl easy handle	
   :type curl: :ref:`libcurl/CURL <libcurl/CURL>`	
   :param kw: libcurl option		
   :type kw: keyword			
   :param arg: libcurl option argument	
   :type arg: see below			
   :return: ``#<unspec>``			
   :raises ^rt-libcurl-error:		
   :raises ^rt-libc-format-error: if `arg` contains an ASCII NUL for a string option	
   :raises ^rt-bignum-conversion-error: if `arg` exceeds limits for a long option	
   					
   `kw` and `arg` should be supplied as two arguments and any	
   number of `kw`/`arg` tuples can be passed.			
   					
   `kw` can be either :samp:`:CURLOPT_{name}` or :samp:`:{name}` for	
   some libcurl option :samp:`CURLOPT_{name}`.  :samp:`:{name}` is	
   case-insensitive.			
   					
   In addition `kw` can be :samp:`:reader` or :samp:`:writer` to	
   use input or output handles as source or sink for libcurl data.	


.. _`libcurl/curl-easy-perform`:

.. idio:function:: libcurl/curl-easy-perform curl


   perform libcurl easy transfer for `curl`	
   					
   :param curl: libcurl easy handle	
   :type curl: :ref:`libcurl/CURL <libcurl/CURL>`	
   :return: ``#<unspec>``			
   :raises ^rt-libcurl-error:		


.. _`libcurl/curl-easy-reset`:

.. idio:function:: libcurl/curl-easy-reset curl


   reset libcurl easy transfer for `curl`	
   					
   :param curl: libcurl easy handle	
   :type curl: :ref:`libcurl/CURL <libcurl/CURL>`	
   :return: ``#<unspec>``			
   :raises ^rt-libcurl-error:		


.. _`libcurl/curl-easy-cleanup`:

.. idio:function:: libcurl/curl-easy-cleanup curl


   cleanup libcurl easy transfer for `curl`	
   					
   :param curl: libcurl easy handle	
   :type curl: :ref:`libcurl/CURL <libcurl/CURL>`	
   :return: ``#<unspec>``			
   :raises ^rt-libcurl-error:		
   					
   In normal circumstances, :manpage:`curl_easy_cleanup(3)`	
   will be called by the garbage collector however you may		
   need to call ``curl-easy-cleanup`` directly.			
   					
   `curl` will be reset to a NULL pointer	




.. include:: ../commit.rst