Source of: /manual/en/function.ldap-get-option.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.ldap.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.ldap-get-option.php',
1 => 'ldap_get_option',
),
'up' =>
array (
0 => 'ref.ldap.php',
1 => 'LDAP Functions',
),
'prev' =>
array (
0 => 'function.ldap-get-entries.php',
1 => 'ldap_get_entries',
),
'next' =>
array (
0 => 'function.ldap-get-values-len.php',
1 => 'ldap_get_values_len',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<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>
<a name="function.ldap-get-option.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>ldap_get_option</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$link_identifier</tt></span>
, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$option</tt></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.php#language.types.mixed" class="type mixed">mixed</a></span> <tt class="parameter reference">&$retval</tt></span>
)</div>
<p class="para rdfs-comment">
Sets <i><tt class="parameter">retval</tt></i>
to the value of the specified option.
</p>
</div>
<a name="function.ldap-get-option.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">link_identifier</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
An LDAP link identifier, returned by <a href="function.ldap-connect.php" class="function">ldap_connect()</a>.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">option</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The parameter <i><tt class="parameter">option</tt></i>
can be one of:
</p><table class="doctable informaltable">
<thead valign="middle">
<tr valign="middle">
<th>Option</th>
<th>Type</th>
</tr>
</thead>
<tbody valign="middle" class="tbody">
<tr valign="middle">
<td align="left"><b><tt class="constant">LDAP_OPT_DEREF</tt></b></td>
<td align="left">integer</td>
</tr>
<tr valign="middle">
<td align="left"><b><tt class="constant">LDAP_OPT_SIZELIMIT</tt></b></td>
<td align="left">integer</td>
</tr>
<tr valign="middle">
<td align="left"><b><tt class="constant">LDAP_OPT_TIMELIMIT</tt></b></td>
<td align="left">integer</td>
</tr>
<tr valign="middle">
<td align="left"><b><tt class="constant">LDAP_OPT_NETWORK_TIMEOUT</tt></b></td>
<td align="left">integer</td>
</tr>
<tr valign="middle">
<td align="left"><b><tt class="constant">LDAP_OPT_PROTOCOL_VERSION</tt></b></td>
<td align="left">integer</td>
</tr>
<tr valign="middle">
<td align="left"><b><tt class="constant">LDAP_OPT_ERROR_NUMBER</tt></b></td>
<td align="left">integer</td>
</tr>
<tr valign="middle">
<td align="left"><b><tt class="constant">LDAP_OPT_REFERRALS</tt></b></td>
<td align="left">bool</td>
</tr>
<tr valign="middle">
<td align="left"><b><tt class="constant">LDAP_OPT_RESTART</tt></b></td>
<td align="left">bool</td>
</tr>
<tr valign="middle">
<td align="left"><b><tt class="constant">LDAP_OPT_HOST_NAME</tt></b></td>
<td align="left">string</td>
</tr>
<tr valign="middle">
<td align="left"><b><tt class="constant">LDAP_OPT_ERROR_STRING</tt></b></td>
<td align="left">string</td>
</tr>
<tr valign="middle">
<td align="left"><b><tt class="constant">LDAP_OPT_MATCHED_DN</tt></b></td>
<td align="left">string</td>
</tr>
<tr valign="middle">
<td align="left"><b><tt class="constant">LDAP_OPT_SERVER_CONTROLS</tt></b></td>
<td align="left">array</td>
</tr>
<tr valign="middle">
<td align="left"><b><tt class="constant">LDAP_OPT_CLIENT_CONTROLS</tt></b></td>
<td align="left">array</td>
</tr>
</tbody>
</table>
<p>
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">retval</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
This will be set to the option value.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.ldap-get-option.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.ldap-get-option.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 Check protocol version</b></p>
<div class="example-contents programlisting">
<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>
</p>
</div>
<a name="function.ldap-get-option.notes"></a><div class="refsect1 notes">
<h3 class="title">Notes</h3>
<blockquote><p><b class="note">Note</b>:
This function is only available when using OpenLDAP 2.x.x OR Netscape
Directory SDK x.x.
<br />
</p></blockquote>
</div>
<a name="function.ldap-get-option.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.ldap-set-option.php" class="function" rel="rdfs-seeAlso">ldap_set_option()</a> - Set the value of the given option</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
