LDAP_GET_OPTION(3) 1 LDAP_GET_OPTION(3)ldap_get_option - Get the current value for given optionSYNOPSIS
bool ldap_get_option (resource $link_identifier, int $option, mixed &$retval)
DESCRIPTION
Sets $retval to the value of the specified option.
PARAMETERS
o $link_identifier
- An LDAP link identifier, returned by ldap_connect(3).
o $option
- The parameter $option can be one of:
+--------------------------+---------+
| Option | |
| | |
| | Type |
| | |
+--------------------------+---------+
| | |
| LDAP_OPT_DEREF | |
| | |
| | integer |
| | |
| | |
| LDAP_OPT_SIZELIMIT | |
| | |
| | integer |
| | |
| | |
| LDAP_OPT_TIMELIMIT | |
| | |
| | integer |
| | |
| | |
|LDAP_OPT_NETWORK_TIMEOUT | |
| | |
| | integer |
| | |
| | |
|LDAP_OPT_PROTOCOL_VERSION | |
| | |
| | integer |
| | |
| | |
| LDAP_OPT_ERROR_NUMBER | |
| | |
| | integer |
| | |
| | |
| LDAP_OPT_REFERRALS | |
| | |
| | bool |
| | |
| | |
| LDAP_OPT_RESTART | |
| | |
| | bool |
| | |
| | |
| LDAP_OPT_HOST_NAME | |
| | |
| | string |
| | |
| | |
| LDAP_OPT_ERROR_STRING | |
| | |
| | string |
| | |
| | |
| LDAP_OPT_MATCHED_DN | |
| | |
| | string |
| | |
| | |
|LDAP_OPT_SERVER_CONTROLS | |
| | |
| | array |
| | |
| | |
|LDAP_OPT_CLIENT_CONTROLS | |
| | |
| | array |
| | |
+--------------------------+---------+
o $retval
- This will be set to the option value.
RETURN VALUES
Returns TRUE on success or FALSE on failure.
EXAMPLES
Example #1
Check protocol version
<?php
// $ds is a valid link identifier for a directory server
if (ldap_get_option($ds, LDAP_OPT_PROTOCOL_VERSION, $version)) {
echo "Using protocol version $version
";
} else {
echo "Unable to determine protocol version
";
}
?>
NOTES
Note
This function is only available when using OpenLDAP 2.x.x OR Netscape Directory SDK x.x.
SEE ALSO ldap_set_option(3).
PHP Documentation Group LDAP_GET_OPTION(3)
Check Out this Related Man Page
SOCKET_SET_OPTION(3) 1 SOCKET_SET_OPTION(3)socket_set_option - Sets socket options for the socketSYNOPSIS
bool socket_set_option (resource $socket, int $level, int $optname, mixed $optval)
DESCRIPTION
The socket_set_option(3) function sets the option specified by the $optname parameter, at the specified protocol $level, to the value
pointed to by the $optval parameter for the $socket.
PARAMETERS
o $socket
- A valid socket resource created with socket_create(3) or socket_accept(3).
o $level
- The $level parameter specifies the protocol level at which the option resides. For example, to retrieve options at the socket
level, a $level parameter of SOL_SOCKET would be used. Other levels, such as TCP, can be used by specifying the protocol number of
that level. Protocol numbers can be found by using the getprotobyname(3) function.
o $optname
- The available socket options are the same as those for the socket_get_option(3) function.
o $optval
- The option value.
RETURN VALUES
Returns TRUE on success or FALSE on failure.
EXAMPLES
Example #1
socket_set_option(3) example
<?php
$socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);
if (!is_resource($socket)) {
echo 'Unable to create socket: '. socket_strerror(socket_last_error()) . PHP_EOL;
}
if (!socket_set_option($socket, SOL_SOCKET, SO_REUSEADDR, 1)) {
echo 'Unable to set option on socket: '. socket_strerror(socket_last_error()) . PHP_EOL;
}
if (!socket_bind($socket, '127.0.0.1', 1223)) {
echo 'Unable to bind socket: '. socket_strerror(socket_last_error()) . PHP_EOL;
}
$rval = socket_get_option($socket, SOL_SOCKET, SO_REUSEADDR);
if ($rval === false) {
echo 'Unable to get socket option: '. socket_strerror(socket_last_error()) . PHP_EOL;
} else if ($rval !== 0) {
echo 'SO_REUSEADDR is set on socket !' . PHP_EOL;
}
?>
PHP Documentation Group SOCKET_SET_OPTION(3)