ldap_get_option

The ldap_get_option function retrieves the current values of session-wide parameters.

ULONG ldap_get_option(
  LDAP* ld,
  int option,
  void* outvalue
);

Parameters

ld

[in] The session handle.

option

[in] The name of the option being accessed. See the Remarks section following for a list of allowable options and their values.

outvalue

[out] The address of the option value. The actual type of this parameter depends on the setting of the option parameter.

Return Values

If the function succeeds, the return value is LDAP_SUCCESS.

If the function fails, it returns an error code. See Return Values for more information.

Remarks

See Session Options for a description of optional settings that apply to an LDAP session.

Multithreading: The ldap_get_option function is thread-safe.

Requirements

  Windows NT/2000: Requires Windows NT 4.0 SP4 or later.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in Winldap.h.
  Library: Use Wldap32.lib.

See Also

Functions, ldap_set_option, Return Values, Session Options