<!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>Get the current value for given option</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ldap-get-entries.html">ldap_get_entries</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ldap-get-values-len.html">ldap_get_values_len</a></div>
<div class="up"><a href="ref.ldap.html">LDAP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.ldap-get-option" class="refentry">
<div class="refnamediv">
<h1 class="refname">ldap_get_option</h1>
<p class="verinfo">(PHP 4 >= 4.0.4, PHP 5)</p><p class="refpurpose"><span class="refname">ldap_get_option</span> — <span class="dc-title">Get the current value for given option</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ldap-get-option-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>ldap_get_option</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$link_identifier</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 reference">&$retval</code></span>
)</div>
<p class="para rdfs-comment">
Sets <em><code class="parameter">retval</code></em> to the value of the specified option.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ldap-get-option-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">link_identifier</code></em></span>
<dd>
<p class="para">
An LDAP link identifier, returned by <span class="function"><a href="function.ldap-connect.html" class="function">ldap_connect()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">option</code></em></span>
<dd>
<p class="para">
The parameter <em><code class="parameter">option</code></em> can be one of:
<table class="doctable informaltable">
<thead>
<tr>
<th>Option</th>
<th>Type</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td><strong><code>LDAP_OPT_DEREF</code></strong></td>
<td>integer</td>
</tr>
<tr>
<td><strong><code>LDAP_OPT_SIZELIMIT</code></strong></td>
<td>integer</td>
</tr>
<tr>
<td><strong><code>LDAP_OPT_TIMELIMIT</code></strong></td>
<td>integer</td>
</tr>
<tr>
<td><strong><code>LDAP_OPT_NETWORK_TIMEOUT</code></strong></td>
<td>integer</td>
</tr>
<tr>
<td><strong><code>LDAP_OPT_PROTOCOL_VERSION</code></strong></td>
<td>integer</td>
</tr>
<tr>
<td><strong><code>LDAP_OPT_ERROR_NUMBER</code></strong></td>
<td>integer</td>
</tr>
<tr>
<td><strong><code>LDAP_OPT_REFERRALS</code></strong></td>
<td>bool</td>
</tr>
<tr>
<td><strong><code>LDAP_OPT_RESTART</code></strong></td>
<td>bool</td>
</tr>
<tr>
<td><strong><code>LDAP_OPT_HOST_NAME</code></strong></td>
<td>string</td>
</tr>
<tr>
<td><strong><code>LDAP_OPT_ERROR_STRING</code></strong></td>
<td>string</td>
</tr>
<tr>
<td><strong><code>LDAP_OPT_MATCHED_DN</code></strong></td>
<td>string</td>
</tr>
<tr>
<td><strong><code>LDAP_OPT_SERVER_CONTROLS</code></strong></td>
<td>array</td>
</tr>
<tr>
<td><strong><code>LDAP_OPT_CLIENT_CONTROLS</code></strong></td>
<td>array</td>
</tr>
</tbody>
</table>
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">retval</code></em></span>
<dd>
<p class="para">
This will be set to the option value.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ldap-get-option-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 class="refsect1 examples" id="refsect1-function.ldap-get-option-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4399">
<p><strong>Example #1 Check protocol version</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// $ds is a valid link identifier for a directory server<br /></span><span style="color: #007700">if (</span><span style="color: #0000BB">ldap_get_option</span><span style="color: #007700">(</span><span style="color: #0000BB">$ds</span><span style="color: #007700">, </span><span style="color: #0000BB">LDAP_OPT_PROTOCOL_VERSION</span><span style="color: #007700">, </span><span style="color: #0000BB">$version</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">"Using protocol version </span><span style="color: #0000BB">$version</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br />} else {<br /> echo </span><span style="color: #DD0000">"Unable to determine protocol version\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.ldap-get-option-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
This function is only available when using OpenLDAP 2.x.x OR Netscape
Directory SDK x.x.
</p>
</p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.ldap-get-option-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.ldap-set-option.html" class="function" rel="rdfs-seeAlso">ldap_set_option()</a> - Set the value of the given option</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ldap-get-entries.html">ldap_get_entries</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ldap-get-values-len.html">ldap_get_values_len</a></div>
<div class="up"><a href="ref.ldap.html">LDAP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
