ldap_set_option()

ld

Connection handle, which is a pointer to an LDAP structure containing information about the connection to the LDAP server.

If NULL, you are setting the default options that will apply to any new LDAP connection handles that are subsequently created.

option

Option that you want to set.

optdata

Pointer to the value of the option that you want to set.

LDAP_OPT_CLIENT_CONTROLS

Pointer to an array of LDAPControl structures representing the LDAP v3 client controls you want sent with every request by default.

The data type for the optdata parameter is (LDAPControl ***).

LDAP_OPT_DEREF

Determines how aliases are handled during a search.

The data type for the optdata parameter is (int *).

optdata can be one of the following values:

• LDAP_DEREF_NEVER specifies that aliases are never dereferenced.

• LDAP_DEREF_SEARCHING specifies that aliases are dereferenced when searching under the base object (but not when finding the base object).

• LDAP_DEREF_FINDING specifies that aliases are dereferenced when finding the base object (but not when searching under the base object).

• LDAP_DEREF_ALWAYS specifies that aliases are always dereferenced when finding the base object and searching under the base object.

LDAP_OPT_DNS_FN_PTRS

Lets you use alternate DNS functions for getting the host entry of an LDAP server.

The data type for the optdata parameter is (struct ldap_dns_fns *).

LDAP_OPT_EXTRA_THREAD_FN_PTRS

Lets you specify the locking and semaphore functions called when getting results from the server. (See Appendix , "Writing Multithreaded Clients" for details.)

The data type for the optdata parameter is (struct ldap_extra_thread_fns *).

LDAP_OPT_IO_FN_PTRS

Lets you use alternate communication stacks.

The data type for the optdata parameter is (struct ldap_io_fns *).

LDAP_OPT_PROTOCOL_VERSION

Version of the protocol supported by your client.

The data type for the optdata parameter is (int *).

You can specify either LDAP_VERSION2 or LDAP_VERSION3. If no version is set, the default is LDAP_VERSION2.

In order to use LDAP v3 features, you need to set the protocol version to LDAP_VERSION3.

LDAP_OPT_REBIND_ARG

Lets you set the last argument passed to the routine specified by LDAP_OPT_REBIND_FN.

You can also set this option by calling the ldap_set_rebind_proc() function.

The data type for the optdata parameter is (void *).

LDAP_OPT_REBIND_FN

Lets you set the routine to be called when you need to authenticate a connection with another LDAP server (for example, during the course of a referral).

You can also set this option by calling the ldap_set_rebind_proc() function.

The data type for the optdata parameter is (LDAP_REBINDPROC_CALLBACK *).

LDAP_OPT_RECONNECT

If the connection to the server is lost, determines whether or not the same connection handle should be used to reconnect to the server.

The data type for the optdata parameter is (int *).

optdata can be one of the following values:

• LDAP_OPT_ON specifies that the same connection handle can be used to reconnect to the server.

• LDAP_OPT_OFF specifies that you want to create a new connection handle to connect to the server.

By default, this option is off.

For details, see "Handling Failover" on page 102.

LDAP_OPT_REFERRALS

Determines whether or not the client should follow referrals.

The data type for the optdata parameter is (int *).

optdata can be one of the following values:

• LDAP_OPT_ON specifies that the client should follow referrals.

• LDAP_OPT_OFF specifies that the client should not follow referrals.

By default, the client follows referrals.

LDAP_OPT_REFERRAL_HOP_LIMIT

Maximum number of referrals the client should follow in a sequence (in other words, the client can only be referred this number of times before it gives up).

The data type for the optdata parameter is (int *).

By default, the maximum number of referrals that the client can follow in a sequence is 5 for the initial connection.

Note that this limit does not apply to individual requests that generate multiple referrals in parallel.

LDAP_OPT_SERVER_CONTROLS

Pointer to an array of LDAPControl structures representing the LDAP v3 server controls you want sent with every request by default.

The data type for the optdata parameter is (LDAPControl ***).

LDAP_OPT_SIZELIMIT

Maximum number of entries that should be returned by the server in search results.

The data type for the optdata parameter is (int *).

LDAP_OPT_SSL

Determines whether or not SSL is enabled.

The data type for the optdata parameter is (int *).

optdata can be one of the following values:

• LDAP_OPT_ON specifies that SSL is enabled.

• LDAP_OPT_OFF specifies that SSL is disabled.

LDAP_OPT_THREAD_FN_PTRS

Lets you specify the thread function pointers. (See Appendix , "Writing Multithreaded Clients" for details.)

The data type for the optdata parameter is (struct ldap_thread_fns *).

LDAP_OPT_TIMELIMIT

Maximum number of seconds that should be spent by the server when answering a search request.

The data type for the optdata parameter is (int *).