docs/libcurl/curl_global_init_mem.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   2  "http://www.w3.org/TR/html4/loose.dtd">
   3 <html><head>
   4 <title>curl_global_init_mem man page</title>
   5 <meta name="generator" content="roffit">
   6 <STYLE type="text/css">
   7 pre {
   8   overflow: auto;
   9   margin: 0;
  10 }
  11
  12 P.level0, pre.level0 {
  13  padding-left: 2em;
  14 }
  15
  16 P.level1, pre.level1 {
  17  padding-left: 4em;
  18 }
  19
  20 P.level2, pre.level2 {
  21  padding-left: 6em;
  22 }
  23
  24 span.emphasis {
  25  font-style: italic;
  26 }
  27
  28 span.bold {
  29  font-weight: bold;
  30 }
  31
  32 span.manpage {
  33  font-weight: bold;
  34 }
  35
  36 h2.nroffsh {
  37  background-color: #e0e0e0;
  38 }
  39
  40 span.nroffip {
  41  font-weight: bold;
  42  font-size: 120%;
  43  font-family: monospace;
  44 }
  45
  46 p.roffit {
  47  text-align: center;
  48  font-size: 80%;
  49 }
  50 </STYLE>
  51 </head><body>
  52
  53 <p class="level0"><a name="NAME"></a><h2 class="nroffsh">NAME</h2>
  54 <p class="level0">curl_global_init_mem - Global libcurl initialisation with memory callbacks <a name="SYNOPSIS"></a><h2 class="nroffsh">SYNOPSIS</h2>
  55 <p class="level0"><span Class="bold">#include &lt;curl/curl.h&gt;</span> <pre class="level0">
  56 <span Class="bold">CURLcode curl_global_init_mem(long  flags,</span>
  57 <span Class="bold"> curl_malloc_callback m,</span>
  58 <span Class="bold"> curl_free_callback f,</span>
  59 <span Class="bold"> curl_realloc_callback r,</span>
  60 <span Class="bold"> curl_strdup_callback s,</span>
  61 <span Class="bold"> curl_calloc_callback c );</span>
  62 </pre>
  63 <a name="DESCRIPTION"></a><h2 class="nroffsh">DESCRIPTION</h2>
  64 <p class="level0">This function works exactly as <a Class="emphasis" href="./curl_global_init.html">curl_global_init</a> with one addition: it allows the application to set callbacks to replace the otherwise used internal memory functions.
  65 <p class="level0">When you use this function, all callback arguments must be set to valid function pointers. <span class="bold">If you are using libcurl from multiple threads or with the threaded resolver (the default in Windows) the callback replacement functions must be thread safe.</span>
  66 <p class="level0">The prototypes for the given callbacks should match these:
  67 <p class="level0"><a name="void"></a><span class="nroffip">void *malloc_callback(size_t size);</span>
  68 <p class="level1">To replace malloc()
  69 <p class="level0"><a name="void"></a><span class="nroffip">void free_callback(void *ptr);</span>
  70 <p class="level1">To replace free()
  71 <p class="level0"><a name="void"></a><span class="nroffip">void *realloc_callback(void *ptr, size_t size);</span>
  72 <p class="level1">To replace realloc()
  73 <p class="level0"><a name="char"></a><span class="nroffip">char *strdup_callback(const char *str);</span>
  74 <p class="level1">To replace strdup()
  75 <p class="level0"><a name="void"></a><span class="nroffip">void *calloc_callback(size_t nmemb, size_t size);</span>
  76 <p class="level1">To replace calloc()
  77 <p class="level0">This function is otherwise the same as <a Class="emphasis" href="./curl_global_init.html">curl_global_init</a>, please refer to that man page for documentation. <a name="CAUTION"></a><h2 class="nroffsh">CAUTION</h2>
  78 <p class="level0">Manipulating these gives considerable powers to the application to severely screw things up for libcurl. Take care! <a name="SEE"></a><h2 class="nroffsh">SEE ALSO</h2>
  79 <p class="level0"><a Class="manpage" href="./curl_global_init.html">curl_global_init</a>, <span Class="manpage"> </span> <a Class="manpage" href="./curl_global_cleanup.html">curl_global_cleanup</a>, <span Class="manpage"> </span>
  80 <p class="level0"><p class="roffit">
  81  This HTML page was made with <a href="http://daniel.haxx.se/projects/roffit/">roffit</a>.
  82 </body></html>