<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Set an option for the cURL multi handle</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.curl-multi-select.html">curl_multi_select</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.curl-multi-strerror.html">curl_multi_strerror</a></div>
<div class="up"><a href="ref.curl.html">cURL Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.curl-multi-setopt" class="refentry">
<div class="refnamediv">
<h1 class="refname">curl_multi_setopt</h1>
<p class="verinfo">(PHP 5 >= 5.5.0)</p><p class="refpurpose"><span class="refname">curl_multi_setopt</span> — <span class="dc-title">Set an option for the cURL multi handle</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.curl-multi-setopt-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>curl_multi_setopt</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$mh</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$option</code></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$value</code></span>
)</div>
<p class="para rdfs-comment">
</p>
<div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function is
currently not documented; only its argument list is available.
</p></div>
</div>
<div class="refsect1 parameters" id="refsect1-function.curl-multi-setopt-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term"><em><code class="parameter">mh</code></em></span>
<dd>
<p class="para">
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">option</code></em></span>
<dd>
<p class="para">
One of the <strong><code>CURLMOPT_*</code></strong> constants.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">value</code></em></span>
<dd>
<p class="para">
The value to be set on <em><code class="parameter">option</code></em>.
</p>
<p class="para">
<em><code class="parameter">value</code></em> should be an <span class="type"><a href="language.types.integer.html" class="type int">int</a></span> for the
following values of the <em><code class="parameter">option</code></em> parameter:
<table class="doctable informaltable">
<thead>
<tr>
<th>Option</th>
<th>Set <em><code class="parameter">value</code></em> to</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td style="vertical-align: top;"><strong><code>CURLMOPT_PIPELINING</code></strong></td>
<td style="vertical-align: top;">
Pass 1 to enable or 0 to disable. Enabling pipelining on a multi
handle will make it attempt to perform HTTP Pipelining as far as
possible for transfers using this handle. This means that if you add
a second request that can use an already existing connection, the
second request will be "piped" on the same connection rather than
being executed in parallel.
</td>
</tr>
<tr>
<td style="vertical-align: top;"><strong><code>CURLMOPT_MAXCONNECTS</code></strong></td>
<td style="vertical-align: top;">
Pass a number that will be used as the maximum amount of
simultaneously open connections that libcurl may cache. Default is
10. When the cache is full, curl closes the oldest one in the cache
to prevent the number of open connections from increasing.
</td>
</tr>
</tbody>
</table>
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.curl-multi-setopt-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.curl-multi-select.html">curl_multi_select</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.curl-multi-strerror.html">curl_multi_strerror</a></div>
<div class="up"><a href="ref.curl.html">cURL Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
