ldap_get_entry_controls_np()--Extract Server Controls from an Entry

Syntax

 #include <ldap.h>
 
 int ldap_get_entry_controls_np(
                        LDAP           *ld,
                        LDAPMessage    *entry,
                        LDAPControl    ***serverctrlsp)

  Default Public Authority: *USE

  Library Name/Service Program: QSYS/QGLDCLNT

  Threadsafe: Yes

The ldap_get_entry_controls_np() routine is used to retrieve an array of server controls returned in an individual entry in a chain of search results.

Note the suffix "_np" which shows the API is in a preliminary implementation, and is not documented in the Internet Draft. The Internet community may standardize this API in the future.

Authorities and Locks

No IBM^® i authority is required.

Parameters

ld: (Input) Specifies the LDAP pointer returned by a previous call to ldap_init(), ldap_ssl_init(), or ldap_open().
entry: (Input) Specifies a pointer to an entry returned on a previous call to ldap_first_entry() or ldap_next_entry().
serverctrlsp: (Input) Specifies a pointer to a result parameter that is filled in with an allocated array of controls copied out of the entry. The control array should be freed by calling ldap_controls_free().

Return Value

LDAP_SUCCESS: if the call was successful
another LDAP error code: if the call was not successful.

Error Conditions

The ldap_get_entry_controls_np() API will return LDAP error code if not successful. See LDAP Client API Error Conditions for possible LDAP error code values.

Error Messages

The following message may be sent from this function.

Message ID	Error Message Text
CPF3CF2 E	Error(s) occurred during running of ldap_get_entry_controls_np API.

Related Information

ldap_first_entry() -- Return first entry in a chain of search results.
ldap_next_entry() -- Return next entry in a chain of search results.
ldap_count_entry() -- Return the number of entry in a chain of search results.
ldap_first_reference() -- Return first continuation reference in a chain of search results.
ldap_next_reference() -- Return next continuation reference in a chain of search results.
ldap_count_references() -- Return number of continuation reference in a chain of search results.
ldap_parse_reference_np() -- Extract information from a continuation reference.

API introduced: V4R5

[ Back to top | LDAP APIs | APIs by category ]