iSeries: Lightweight Directory Access Protocol (LDAP) APIs

326 Pages·2005·3.98 MB·English

(cid:1)(cid:2)(cid:3)
ERserver

iSeries
Lightweight Directory Access Protocol (LDAP) APIs

Version 5 Release 3

(cid:1)(cid:2)(cid:3)
ERserver

iSeries
Lightweight Directory Access Protocol (LDAP) APIs

Version 5 Release 3
Note

Before using this information and the product it supports, be sure to read the information in

“Notices,” on page 307.

SixthEdition(August2005)

Thiseditionappliestoversion5,release3,modification0ofOperatingSystem/400(productnumber5722-SS1)and

toallsubsequentreleasesandmodificationsuntilotherwiseindicatedinneweditions.Thisversiondoesnotrunon

allreducedinstructionsetcomputer(RISC)modelsnordoesitrunonCISCmodels.

©CopyrightInternationalBusinessMachinesCorporation1998,2005.Allrightsreserved.

USGovernmentUsersRestrictedRights–Use,duplicationordisclosurerestrictedbyGSAADPScheduleContract

withIBMCorp.
Contents

Lightweight Directory Access Protocol RelatedInformation . . . . . . . . . . 16

(LDAP) APIs . . . . . . . . . . . . . 1 ldap_app_ssl_client_init_np()—InitializetheLDAP

ClientforaSecureConnectionusingDCM. . . . 16
APIs . . . . . . . . . . . . . . . . . 6
AuthoritiesandLocks. . . . . . . . . . 17
ldap_abandon()—AbandonanLDAPOperationin
Parameters . . . . . . . . . . . . . 17
Progress. . . . . . . . . . . . . . . . 6
Examples . . . . . . . . . . . . . . 17
AuthoritiesandLocks . . . . . . . . . . 7
ReturnValue . . . . . . . . . . . . . 18
Parameters . . . . . . . . . . . . . . 7
ErrorConditions. . . . . . . . . . . . 18
ReturnValue . . . . . . . . . . . . . 7
ErrorMessages . . . . . . . . . . . . 18
ErrorConditions . . . . . . . . . . . . 7
RelatedInformation . . . . . . . . . . 18
ErrorMessages . . . . . . . . . . . . 7
ldap_app_ssl_init_np—InitializesanSSL
RelatedInformation . . . . . . . . . . . 7
Connection . . . . . . . . . . . . . . 19
ldap_abandon_ext()—Abandon(abort)an
AuthoritiesandLocks. . . . . . . . . . 19
AsynchronousOperationwithControls . . . . . 8
Parameters . . . . . . . . . . . . . 19
AuthoritiesandLocks . . . . . . . . . . 8
ReturnValue . . . . . . . . . . . . . 20
Parameters . . . . . . . . . . . . . . 8
ErrorConditions. . . . . . . . . . . . 20
ReturnValue . . . . . . . . . . . . . 8
ErrorMessages . . . . . . . . . . . . 21
ErrorConditions . . . . . . . . . . . . 9
RelatedInformation . . . . . . . . . . 21
ErrorMessages . . . . . . . . . . . . 9
Example . . . . . . . . . . . . . . 21
RelatedInformation . . . . . . . . . . . 9
ldap_app_ssl_start_np()—StartaSecureLDAP
ldap_add()—PerformanLDAPAddOperation. . . 9
ConnectionusingDCM . . . . . . . . . . 21
AuthoritiesandLocks . . . . . . . . . . 9
AuthoritiesandLocks. . . . . . . . . . 22
Parameters . . . . . . . . . . . . . . 9
Parameters . . . . . . . . . . . . . 22
ReturnValue . . . . . . . . . . . . . 10
ReturnValue . . . . . . . . . . . . . 22
ErrorConditions. . . . . . . . . . . . 10
ErrorConditions. . . . . . . . . . . . 22
ErrorMessages . . . . . . . . . . . . 10
ErrorMessages . . . . . . . . . . . . 22
RelatedInformation . . . . . . . . . . 10
RelatedInformation . . . . . . . . . . 22
ldap_add_control()—CreateaControlandInsertit
Example . . . . . . . . . . . . . . 23
intotheListofLDAPServerControls . . . . . 11
ldap_ber_free()—FreestorageallocatedbytheLDAP
AuthoritiesandLocks. . . . . . . . . . 11
library . . . . . . . . . . . . . . . . 23
Parameters . . . . . . . . . . . . . 11
AuthoritiesandLocks. . . . . . . . . . 24
ReturnValue . . . . . . . . . . . . . 11
Parameters . . . . . . . . . . . . . 24
RelatedInformation . . . . . . . . . . 11
ReturnValue . . . . . . . . . . . . . 24
ldap_add_ext()—PerformanLDAPAddOperation
ErrorConditions. . . . . . . . . . . . 24
withControls. . . . . . . . . . . . . . 12
ErrorMessages . . . . . . . . . . . . 24
AuthoritiesandLocks. . . . . . . . . . 12
RelatedInformation . . . . . . . . . . 24
Parameters . . . . . . . . . . . . . 12
ldap_bind()—PerformanLDAPBindRequest. . . 24
ReturnValue . . . . . . . . . . . . . 13
AuthoritiesandLocks. . . . . . . . . . 25
ErrorConditions. . . . . . . . . . . . 13
Parameters . . . . . . . . . . . . . 25
ErrorMessages . . . . . . . . . . . . 13
ReturnValue . . . . . . . . . . . . . 25
RelatedInformation . . . . . . . . . . 13
ErrorConditions. . . . . . . . . . . . 25
ldap_add_ext_s()—PerformanLDAPAdd
ErrorMessages . . . . . . . . . . . . 25
OperationwithControls(Synchronous) . . . . . 14
RelatedInformation . . . . . . . . . . 25
AuthoritiesandLocks. . . . . . . . . . 14
ldap_bind_s()—PerformanLDAPBindRequest
Parameters . . . . . . . . . . . . . 14
(Synchronous) . . . . . . . . . . . . . 26
ReturnValue . . . . . . . . . . . . . 14
AuthoritiesandLocks. . . . . . . . . . 26
ErrorConditions. . . . . . . . . . . . 14
Parameters . . . . . . . . . . . . . 27
ErrorMessages . . . . . . . . . . . . 15
ReturnValue . . . . . . . . . . . . . 27
RelatedInformation . . . . . . . . . . 15
ErrorConditions. . . . . . . . . . . . 27
ldap_add_s()—PerformanLDAPAddOperation
ErrorMessages . . . . . . . . . . . . 27
(Synchronous) . . . . . . . . . . . . . 15
RelatedInformation . . . . . . . . . . 27
AuthoritiesandLocks. . . . . . . . . . 15
ldap_compare()—PerformanLDAPCompare
Parameters . . . . . . . . . . . . . 15
Operation . . . . . . . . . . . . . . . 28
ReturnValue . . . . . . . . . . . . . 16
AuthoritiesandLocks. . . . . . . . . . 28
ErrorConditions. . . . . . . . . . . . 16
Parameters . . . . . . . . . . . . . 28
ErrorMessages . . . . . . . . . . . . 16
ReturnValue . . . . . . . . . . . . . 28

© Copyright IBM Corp. 1998, 2005 iii
ErrorConditions. . . . . . . . . . . . 29 ReturnValue . . . . . . . . . . . . . 39

ErrorMessages . . . . . . . . . . . . 29 ErrorConditions. . . . . . . . . . . . 39

RelatedInformation . . . . . . . . . . 29 ErrorMessages . . . . . . . . . . . . 39

ldap_compare_ext()—PerformanLDAPCompare RelatedInformation . . . . . . . . . . 39

OperationwithControls . . . . . . . . . . 29 ldap_count_messages()—Countmessagesinaresult

AuthoritiesandLocks. . . . . . . . . . 30 chain . . . . . . . . . . . . . . . . 40

Parameters . . . . . . . . . . . . . 30 AuthoritiesandLocks. . . . . . . . . . 40

ReturnValue . . . . . . . . . . . . . 30 Parameters . . . . . . . . . . . . . 40

ErrorConditions. . . . . . . . . . . . 30 ReturnValue . . . . . . . . . . . . . 40

ErrorMessages . . . . . . . . . . . . 30 ErrorConditions. . . . . . . . . . . . 40

RelatedInformation . . . . . . . . . . 31 ErrorMessages . . . . . . . . . . . . 40

ldap_compare_ext_s()—PerformanLDAPCompare RelatedInformation . . . . . . . . . . 41

OperationwithControls(Synchronous) . . . . . 31 ldap_count_references()—Countcontinuation

AuthoritiesandLocks. . . . . . . . . . 31 referencesinachainofsearchresults. . . . . . 41

Parameters . . . . . . . . . . . . . 31 AuthoritiesandLocks. . . . . . . . . . 41

ReturnValue . . . . . . . . . . . . . 32 Parameters . . . . . . . . . . . . . 41

ErrorConditions. . . . . . . . . . . . 32 ReturnValue . . . . . . . . . . . . . 42

ErrorMessages . . . . . . . . . . . . 32 ErrorConditions. . . . . . . . . . . . 42

RelatedInformation . . . . . . . . . . 32 ErrorMessages . . . . . . . . . . . . 42

ldap_compare_s()—PerformanLDAPCompare RelatedInformation . . . . . . . . . . 42

Operation(Synchronous). . . . . . . . . . 33 ldap_count_values()—RetrieveCountofAttribute

AuthoritiesandLocks. . . . . . . . . . 33 Values . . . . . . . . . . . . . . . . 42

Parameters . . . . . . . . . . . . . 33 AuthoritiesandLocks. . . . . . . . . . 42

ReturnValue . . . . . . . . . . . . . 33 Parameters . . . . . . . . . . . . . 43

ErrorConditions. . . . . . . . . . . . 33 ReturnValue . . . . . . . . . . . . . 43

ErrorMessages . . . . . . . . . . . . 34 ErrorConditions. . . . . . . . . . . . 43

RelatedInformation . . . . . . . . . . 34 ErrorMessages . . . . . . . . . . . . 43

ldap_controls_free()—Freestorageallocatedbythe RelatedInformation . . . . . . . . . . 43

LDAPlibrary. . . . . . . . . . . . . . 34 ldap_count_values_len()—RetrieveCountofBinary

AuthoritiesandLocks. . . . . . . . . . 34 AttributeValues. . . . . . . . . . . . . 44

Parameters . . . . . . . . . . . . . 34 AuthoritiesandLocks. . . . . . . . . . 44

ReturnValue . . . . . . . . . . . . . 34 Parameters . . . . . . . . . . . . . 44

ErrorConditions. . . . . . . . . . . . 34 ReturnValue . . . . . . . . . . . . . 44

ErrorMessages . . . . . . . . . . . . 35 ErrorConditions. . . . . . . . . . . . 44

RelatedInformation . . . . . . . . . . 35 ErrorMessages . . . . . . . . . . . . 44

ldap_control_free()—Freestorageallocatedbythe RelatedInformation . . . . . . . . . . 45

LDAPlibrary. . . . . . . . . . . . . . 35 ldap_create_page_control()—CreateaPagedResults

AuthoritiesandLocks. . . . . . . . . . 35 Controlusedwhenpagingsearchresults . . . . 45

Parameters . . . . . . . . . . . . . 35 AuthoritiesandLocks. . . . . . . . . . 45

ReturnValue . . . . . . . . . . . . . 35 Parameters . . . . . . . . . . . . . 45

ErrorConditions. . . . . . . . . . . . 36 ReturnValue . . . . . . . . . . . . . 46

ErrorMessages . . . . . . . . . . . . 36 RelatedInformation . . . . . . . . . . 46

RelatedInformation . . . . . . . . . . 36 ldap_create_sort_control()—CreateaSortedResults

ldap_copy_controls()—MakeaCopyoftheListof ControlusedwhenSortingSearchResults . . . . 47

LDAPServerControls. . . . . . . . . . . 36 AuthoritiesandLocks. . . . . . . . . . 47

AuthoritiesandLocks. . . . . . . . . . 36 Parameters . . . . . . . . . . . . . 47

Parameters . . . . . . . . . . . . . 36 ReturnValue . . . . . . . . . . . . . 48

ReturnValue . . . . . . . . . . . . . 37 RelatedInformation . . . . . . . . . . 48

RelatedInformation . . . . . . . . . . 37 ldap_create_sort_keylist()—CreateaStructurewith

ldap_count_attributes()—RetrieveCountof SortKeyValuesusedwhenSortingSearchResults . 49

AttributesforanLDAPEntry . . . . . . . . 37 AuthoritiesandLocks. . . . . . . . . . 49

AuthoritiesandLocks. . . . . . . . . . 37 Parameters . . . . . . . . . . . . . 49

Parameters . . . . . . . . . . . . . 37 ReturnValue . . . . . . . . . . . . . 49

ReturnValue . . . . . . . . . . . . . 38 RelatedInformation . . . . . . . . . . 49

ErrorConditions. . . . . . . . . . . . 38 ldap_default_dn_get()—RetrievetheUser’sDefault

ErrorMessages . . . . . . . . . . . . 38 DN . . . . . . . . . . . . . . . . . 50

RelatedInformation . . . . . . . . . . 38 AuthoritiesandLocks. . . . . . . . . . 50

ldap_count_entries()—RetrieveCountofLDAP Parameters . . . . . . . . . . . . . 50

Entries . . . . . . . . . . . . . . . . 38 ReturnValue . . . . . . . . . . . . . 51

AuthoritiesandLocks. . . . . . . . . . 38 ErrorConditions. . . . . . . . . . . . 51

Parameters . . . . . . . . . . . . . 39 ErrorMessages . . . . . . . . . . . . 51

iv iSeries: LightweightDirectoryAccessProtocol(LDAP)APIs
RelatedInformation . . . . . . . . . . 51 ErrorMessages . . . . . . . . . . . . 62

ldap_default_dn_set()—StoretheUser’sDefaultDN 51 RelatedInformation . . . . . . . . . . 62

AuthoritiesandLocks. . . . . . . . . . 52 ldap_err2string()—RetrieveLDAPErrorMessage

Parameters . . . . . . . . . . . . . 52 String . . . . . . . . . . . . . . . . 62

ReturnValue . . . . . . . . . . . . . 52 AuthoritiesandLocks. . . . . . . . . . 63

ErrorConditions. . . . . . . . . . . . 52 Parameters . . . . . . . . . . . . . 63

ErrorMessages . . . . . . . . . . . . 52 ReturnValue . . . . . . . . . . . . . 63

RelatedInformation . . . . . . . . . . 52 ErrorConditions. . . . . . . . . . . . 63

ldap_delete()—PerformanLDAPDeleteOperation 53 ErrorMessages . . . . . . . . . . . . 63

AuthoritiesandLocks. . . . . . . . . . 53 RelatedInformation . . . . . . . . . . 63

Parameters . . . . . . . . . . . . . 53 ldap_explode_dn()—BreakaDistinguishedName

ReturnValue . . . . . . . . . . . . . 53 intoItsComponents . . . . . . . . . . . 64

ErrorConditions. . . . . . . . . . . . 53 AuthoritiesandLocks. . . . . . . . . . 64

ErrorMessages . . . . . . . . . . . . 53 Parameters . . . . . . . . . . . . . 64

RelatedInformation . . . . . . . . . . 54 ReturnValue . . . . . . . . . . . . . 64

ldap_delete_ext()—PerformanLDAPDelete ErrorConditions. . . . . . . . . . . . 64

OperationwithControls . . . . . . . . . . 54 ErrorMessages . . . . . . . . . . . . 64

AuthoritiesandLocks. . . . . . . . . . 54 RelatedInformation . . . . . . . . . . 65

Parameters . . . . . . . . . . . . . 54 ldap_explode_dns()—BreakaDNS-style

ReturnValue . . . . . . . . . . . . . 55 DistinguishedNameintoItsComponents . . . . 65

ErrorConditions. . . . . . . . . . . . 55 AuthoritiesandLocks. . . . . . . . . . 65

ErrorMessages . . . . . . . . . . . . 55 Parameters . . . . . . . . . . . . . 65

RelatedInformation . . . . . . . . . . 55 ReturnValue . . . . . . . . . . . . . 65

ldap_delete_ext_s()—PerformanLDAPDelete ErrorConditions. . . . . . . . . . . . 66

OperationwithControls . . . . . . . . . . 56 ErrorMessages . . . . . . . . . . . . 66

AuthoritiesandLocks. . . . . . . . . . 56 RelatedInformation . . . . . . . . . . 66

Parameters . . . . . . . . . . . . . 56 ldap_explode_dn_utf8()—BreakaUTF8codepage

ReturnValue . . . . . . . . . . . . . 56 DistinguishedNameintoItsComponents . . . . 66

ErrorConditions. . . . . . . . . . . . 56 AuthoritiesandLocks. . . . . . . . . . 67

ErrorMessages . . . . . . . . . . . . 56 Parameters . . . . . . . . . . . . . 67

RelatedInformation . . . . . . . . . . 57 ReturnValue . . . . . . . . . . . . . 67

ldap_delete_s()—PerformanLDAPDelete ErrorConditions. . . . . . . . . . . . 67

Operation(Synchronous). . . . . . . . . . 57 ErrorMessages . . . . . . . . . . . . 67

AuthoritiesandLocks. . . . . . . . . . 57 RelatedInformation . . . . . . . . . . 67

Parameters . . . . . . . . . . . . . 57 ldap_explode_rdn()—BreakaRelativeDistinguished

ReturnValue . . . . . . . . . . . . . 57 NameintoItsComponents . . . . . . . . . 68

ErrorConditions. . . . . . . . . . . . 58 AuthoritiesandLocks. . . . . . . . . . 68

ErrorMessages . . . . . . . . . . . . 58 Parameters . . . . . . . . . . . . . 68

RelatedInformation . . . . . . . . . . 58 ReturnValue . . . . . . . . . . . . . 68

ldap_dn2ufn()—ConvertaDistinguishedNameinto ErrorConditions. . . . . . . . . . . . 68

aUserFriendlyName. . . . . . . . . . . 58 ErrorMessages . . . . . . . . . . . . 69

AuthoritiesandLocks. . . . . . . . . . 58 RelatedInformation . . . . . . . . . . 69

Parameters . . . . . . . . . . . . . 59 ldap_explode_rdn_utf8()—BreakaUTF8codepage

ReturnValue . . . . . . . . . . . . . 59 RelativeDistinguishedNameintoItsComponents . 69

ErrorConditions. . . . . . . . . . . . 59 AuthoritiesandLocks. . . . . . . . . . 69

ErrorMessages . . . . . . . . . . . . 59 Parameters . . . . . . . . . . . . . 70

RelatedInformation . . . . . . . . . . 59 ReturnValue . . . . . . . . . . . . . 70

ldap_enetwork_domain_get()—RetrievetheUser’s ErrorConditions. . . . . . . . . . . . 70

DefaulteNetworkDomainName . . . . . . . 59 ErrorMessages . . . . . . . . . . . . 70

AuthoritiesandLocks. . . . . . . . . . 60 RelatedInformation . . . . . . . . . . 70

Parameters . . . . . . . . . . . . . 60 ldap_extended_operation()—Performextended

ReturnValue . . . . . . . . . . . . . 60 operations. . . . . . . . . . . . . . . 71

ErrorConditions. . . . . . . . . . . . 60 AuthoritiesandLocks. . . . . . . . . . 71

ErrorMessages . . . . . . . . . . . . 60 Parameters . . . . . . . . . . . . . 71

RelatedInformation . . . . . . . . . . 60 ReturnValue . . . . . . . . . . . . . 72

ldap_enetwork_domain_set()—StoretheUser’s ErrorConditions. . . . . . . . . . . . 72

DefaulteNetworkDomainName . . . . . . . 61 ErrorMessages . . . . . . . . . . . . 72

AuthoritiesandLocks. . . . . . . . . . 61 RelatedInformation . . . . . . . . . . 72

Parameters . . . . . . . . . . . . . 61 ldap_extended_operation_s()—Performextended

ReturnValue . . . . . . . . . . . . . 62 operationssynchronously. . . . . . . . . . 73

ErrorConditions. . . . . . . . . . . . 62 AuthoritiesandLocks. . . . . . . . . . 74

Contents v
Parameters . . . . . . . . . . . . . 74 ErrorConditions. . . . . . . . . . . . 86

ReturnValue . . . . . . . . . . . . . 74 ErrorMessages . . . . . . . . . . . . 86

ErrorConditions. . . . . . . . . . . . 74 RelatedInformation . . . . . . . . . . 86

ErrorMessages . . . . . . . . . . . . 74 ldap_get_errno()—RetrieveErrorInformation . . . 87

RelatedInformation . . . . . . . . . . 74 AuthoritiesandLocks. . . . . . . . . . 87

ldap_first_attribute()—RetrieveFirstAttributeinan Parameters . . . . . . . . . . . . . 87

Entry . . . . . . . . . . . . . . . . 75 ReturnValue . . . . . . . . . . . . . 87

AuthoritiesandLocks. . . . . . . . . . 76 ErrorMessages . . . . . . . . . . . . 87

Parameters . . . . . . . . . . . . . 76 RelatedInformation . . . . . . . . . . 87

ReturnValue . . . . . . . . . . . . . 76 ldap_get_iconv_local_codepage()—GettheActive

ErrorConditions. . . . . . . . . . . . 76 LDAPCodePage . . . . . . . . . . . . 88

ErrorMessages . . . . . . . . . . . . 76 AuthoritiesandLocks. . . . . . . . . . 88

RelatedInformation . . . . . . . . . . 76 Parameters . . . . . . . . . . . . . 88

ldap_first_entry()—RetrieveFirstLDAPEntry. . . 77 ReturnValue . . . . . . . . . . . . . 88

AuthoritiesandLocks. . . . . . . . . . 77 ErrorConditions. . . . . . . . . . . . 88

Parameters . . . . . . . . . . . . . 77 ErrorMessages . . . . . . . . . . . . 88

ReturnValue . . . . . . . . . . . . . 77 RelatedInformation . . . . . . . . . . 89

ErrorConditions. . . . . . . . . . . . 78 ldap_get_lderrno()—RetrieveErrorInformation . . 89

ErrorMessages . . . . . . . . . . . . 78 AuthoritiesandLocks. . . . . . . . . . 89

RelatedInformation . . . . . . . . . . 78 Parameters . . . . . . . . . . . . . 90

ldap_first_message()—RetrieveFirstLDAPMessage 79 ReturnValue . . . . . . . . . . . . . 90

AuthoritiesandLocks. . . . . . . . . . 79 ErrorMessages . . . . . . . . . . . . 90

Parameters . . . . . . . . . . . . . 79 RelatedInformation . . . . . . . . . . 90

ReturnValue . . . . . . . . . . . . . 79 ldap_get_locale()—GetActiveLDAPLocale . . . 91

ErrorConditions. . . . . . . . . . . . 79 AuthoritiesandLocks. . . . . . . . . . 91

ErrorMessages . . . . . . . . . . . . 79 Parameters . . . . . . . . . . . . . 91

RelatedInformation . . . . . . . . . . 80 ReturnValue . . . . . . . . . . . . . 91

ldap_first_reference()—RetrieveFirstContinuation ErrorConditions. . . . . . . . . . . . 91

ReferenceinaChainofSearchResults . . . . . 80 ErrorMessages . . . . . . . . . . . . 91

AuthoritiesandLocks. . . . . . . . . . 80 RelatedInformation . . . . . . . . . . 91

Parameters . . . . . . . . . . . . . 80 ldap_get_option()—RetrieveLDAPOptions. . . . 92

ReturnValue . . . . . . . . . . . . . 81 AuthoritiesandLocks. . . . . . . . . . 92

ErrorConditions. . . . . . . . . . . . 81 Parameters . . . . . . . . . . . . . 92

ErrorMessages . . . . . . . . . . . . 81 LDAP_OPT_SIZELIMIT . . . . . . . . . 93

RelatedInformation . . . . . . . . . . 81 LDAP_OPT_TIMELIMIT . . . . . . . . . 93

ldap_free_sort_keylist()—FreeallMemoryusedby LDAP_OPT_REFHOPLIMIT. . . . . . . . 93

theSortKeyList . . . . . . . . . . . . 82 LDAP_OPT_DEREF . . . . . . . . . . 94

AuthoritiesandLocks. . . . . . . . . . 82 LDAP_OPT_REFERRALS. . . . . . . . . 94

Parameters . . . . . . . . . . . . . 82 LDAP_OPT_DEBUG . . . . . . . . . . 94

ReturnValue . . . . . . . . . . . . . 82 LDAP_OPT_SSL_CIPHER . . . . . . . . 95

RelatedInformation . . . . . . . . . . 82 LDAP_OPT_SSL_TIMEOUT. . . . . . . . 95

ldap_free_urldesc()—FreeanLDAPURLDescription 83 LDAP_OPT_REBIND_FN. . . . . . . . . 95

AuthoritiesandLocks. . . . . . . . . . 83 LDAP_OPT_PROTOCOL_VERSION . . . . . 95

Parameters . . . . . . . . . . . . . 83 LDAP_OPT_SERVER_CONTROLS. . . . . . 96

ReturnValue . . . . . . . . . . . . . 83 LDAP_OPT_CLIENT_CONTROLS. . . . . . 96

ErrorConditions. . . . . . . . . . . . 83 LDAP_OPT_UTF8_IO . . . . . . . . . . 96

ErrorMessages . . . . . . . . . . . . 83 LDAP_OPT_HOST_NAME . . . . . . . . 97

RelatedInformation . . . . . . . . . . 84 LDAP_OPT_ERROR_NUMBER. . . . . . . 97

ldap_get_dn()—RetrievetheDistinguishedNameof LDAP_OPT_ERROR_STRING . . . . . . . 97

anEntry . . . . . . . . . . . . . . . 84 LDAP_OPT_EXT_ERROR. . . . . . . . . 98

AuthoritiesandLocks. . . . . . . . . . 84 LDAP_OPT_EXT_GSS_ERR . . . . . . . . 98

Parameters . . . . . . . . . . . . . 84 ReturnValue . . . . . . . . . . . . . 98

ReturnValue . . . . . . . . . . . . . 85 ErrorConditions. . . . . . . . . . . . 98

ErrorConditions. . . . . . . . . . . . 85 ErrorMessages . . . . . . . . . . . . 98

ErrorMessages . . . . . . . . . . . . 85 RelatedInformation . . . . . . . . . . 98

RelatedInformation . . . . . . . . . . 85 ldap_get_values()—RetrieveaSetofAttribute

ldap_get_entry_controls_np()—ExtractServer ValuesfromanEntry . . . . . . . . . . . 99

ControlsfromanEntry . . . . . . . . . . 85 AuthoritiesandLocks. . . . . . . . . . 99

AuthoritiesandLocks. . . . . . . . . . 86 Parameters . . . . . . . . . . . . . 99

Parameters . . . . . . . . . . . . . 86 ReturnValue . . . . . . . . . . . . . 99

ReturnValue . . . . . . . . . . . . . 86 ErrorConditions. . . . . . . . . . . . 99

vi iSeries: LightweightDirectoryAccessProtocol(LDAP)APIs
ErrorMessages . . . . . . . . . . . . 99 ErrorMessages. . . . . . . . . . . . 114

RelatedInformation . . . . . . . . . . 100 RelatedInformation . . . . . . . . . . 115

ldap_get_values_len()—RetrieveaSetofBinary ldap_modify_s()—PerformanLDAPModifyEntry

AttributeValues . . . . . . . . . . . . 100 Request(Synchronous) . . . . . . . . . . 115

AuthoritiesandLocks . . . . . . . . . 101 AuthoritiesandLocks . . . . . . . . . 116

Parameters . . . . . . . . . . . . . 101 Parameters . . . . . . . . . . . . . 116

ReturnValue . . . . . . . . . . . . 101 ReturnValue . . . . . . . . . . . . 116

ErrorConditions . . . . . . . . . . . 101 ErrorConditions . . . . . . . . . . . 116

ErrorMessages. . . . . . . . . . . . 101 ErrorMessages. . . . . . . . . . . . 117

RelatedInformation . . . . . . . . . . 101 RelatedInformation . . . . . . . . . . 117

ldap_init()—PerformanLDAPInitialization ldap_modrdn()—PerformanLDAPModifyRDN

Operation . . . . . . . . . . . . . . 102 Request . . . . . . . . . . . . . . . 117

AuthoritiesandLocks . . . . . . . . . 102 AuthoritiesandLocks . . . . . . . . . 118

Parameters . . . . . . . . . . . . . 102 Parameters . . . . . . . . . . . . . 118

ReturnValue . . . . . . . . . . . . 103 ReturnValue . . . . . . . . . . . . 118

ErrorConditions . . . . . . . . . . . 103 ErrorConditions . . . . . . . . . . . 118

ErrorMessages. . . . . . . . . . . . 104 ErrorMessages. . . . . . . . . . . . 118

RelatedInformation . . . . . . . . . . 104 RelatedInformation . . . . . . . . . . 118

ldap_insert_control()—InsertaControlintheLlist ldap_modrdn_s()—PerformanLDAPModifyRDN

ofLDAPServerControls . . . . . . . . . 104 Request(Synchronous) . . . . . . . . . . 119

AuthoritiesandLocks . . . . . . . . . 104 AuthoritiesandLocks . . . . . . . . . 119

Parameters . . . . . . . . . . . . . 104 Parameters . . . . . . . . . . . . . 119

ReturnValue . . . . . . . . . . . . 105 ReturnValue . . . . . . . . . . . . 120

RelatedInformation . . . . . . . . . . 105 ErrorConditions . . . . . . . . . . . 120

ldap_is_ldap_url()—VerifyLDAPURL . . . . . 105 ErrorMessages. . . . . . . . . . . . 120

AuthoritiesandLocks . . . . . . . . . 105 RelatedInformation . . . . . . . . . . 120

Parameters . . . . . . . . . . . . . 105 ldap_mods_free()—FreeLDAPModifyStorage . . 121

ReturnValue . . . . . . . . . . . . 106 AuthoritiesandLocks . . . . . . . . . 121

ErrorConditions . . . . . . . . . . . 106 Parameters . . . . . . . . . . . . . 121

ErrorMessages. . . . . . . . . . . . 106 ReturnValue . . . . . . . . . . . . 121

RelatedInformation . . . . . . . . . . 106 ErrorConditions . . . . . . . . . . . 121

ldap_memfree()—FreeMemoryAllocatedbyLDAP ErrorMessages. . . . . . . . . . . . 121

API. . . . . . . . . . . . . . . . . 106 RelatedInformation . . . . . . . . . . 121

AuthoritiesandLocks . . . . . . . . . 107 ldap_msgfree()—FreeLDAPResultMessage . . . 122

Parameters . . . . . . . . . . . . . 107 AuthoritiesandLocks . . . . . . . . . 122

ReturnValue . . . . . . . . . . . . 107 Parameters . . . . . . . . . . . . . 122

ErrorConditions . . . . . . . . . . . 107 ReturnValues . . . . . . . . . . . . 123

ErrorMessages. . . . . . . . . . . . 107 ErrorConditions . . . . . . . . . . . 123

RelatedInformation . . . . . . . . . . 107 ErrorMessages. . . . . . . . . . . . 123

ldap_modify()—PerformanLDAPModifyEntry RelatedInformation . . . . . . . . . . 123

Request . . . . . . . . . . . . . . . 108 ldap_msgid()—RetrievetheMessageIDAssociated

AuthoritiesandLocks . . . . . . . . . 109 withanLDAPMessage . . . . . . . . . . 124

Parameters . . . . . . . . . . . . . 109 AuthoritiesandLocks . . . . . . . . . 124

ReturnValue . . . . . . . . . . . . 109 Parameters . . . . . . . . . . . . . 124

ErrorConditions . . . . . . . . . . . 109 ReturnValue . . . . . . . . . . . . 124

ErrorMessages. . . . . . . . . . . . 109 ErrorConditions . . . . . . . . . . . 124

RelatedInformation . . . . . . . . . . 109 ErrorMessages. . . . . . . . . . . . 124

ldap_modify_ext()—PerformanLDAPModify RelatedInformation . . . . . . . . . . 124

EntryRequestwithControls . . . . . . . . 110 ldap_msgtype()—RetrievetheTypeofanLDAP

AuthoritiesandLocks . . . . . . . . . 111 Message . . . . . . . . . . . . . . . 126

Parameters . . . . . . . . . . . . . 111 AuthoritiesandLocks . . . . . . . . . 126

ReturnValue . . . . . . . . . . . . 111 Parameters . . . . . . . . . . . . . 126

ErrorConditions . . . . . . . . . . . 112 ReturnValue . . . . . . . . . . . . 126

ErrorMessages. . . . . . . . . . . . 112 ErrorConditions . . . . . . . . . . . 126

RelatedInformation . . . . . . . . . . 112 ErrorMessages. . . . . . . . . . . . 126

ldap_modify_ext_s()—PerformanLDAPModify RelatedInformation . . . . . . . . . . 127

EntryRequestwithControls . . . . . . . . 113 ldap_next_attribute()—RetrieveNextAttributein

AuthoritiesandLocks . . . . . . . . . 114 anEntry . . . . . . . . . . . . . . . 127

Parameters . . . . . . . . . . . . . 114 AuthoritiesandLocks . . . . . . . . . 127

ReturnValue . . . . . . . . . . . . 114 Parameters . . . . . . . . . . . . . 128

ErrorConditions . . . . . . . . . . . 114 ReturnValue . . . . . . . . . . . . 128

Contents vii
ErrorConditions . . . . . . . . . . . 128 RelatedInformation . . . . . . . . . . 142

ErrorMessages. . . . . . . . . . . . 128 ldap_parse_result()—ExtractInformationfrom

RelatedInformation . . . . . . . . . . 128 Results . . . . . . . . . . . . . . . 143

ldap_next_entry()—RetrieveNextLDAPEntry . . 129 AuthoritiesandLocks . . . . . . . . . 143

AuthoritiesandLocks . . . . . . . . . 129 Parameters . . . . . . . . . . . . . 143

Parameters . . . . . . . . . . . . . 129 ReturnValue . . . . . . . . . . . . 144

ReturnValue . . . . . . . . . . . . 129 ErrorConditions . . . . . . . . . . . 144

ErrorConditions . . . . . . . . . . . 129 ErrorMessages. . . . . . . . . . . . 144

ErrorMessages. . . . . . . . . . . . 129 RelatedInformation . . . . . . . . . . 145

RelatedInformation . . . . . . . . . . 130 ldap_parse_sasl_bind_result()—ExtractServer

ldap_next_message()—RetrieveNextLDAP CredentialsfromSASLBindResults. . . . . . 145

Message . . . . . . . . . . . . . . . 130 AuthoritiesandLocks . . . . . . . . . 145

AuthoritiesandLocks . . . . . . . . . 130 Parameters . . . . . . . . . . . . . 145

Parameters . . . . . . . . . . . . . 130 ReturnValue . . . . . . . . . . . . 146

ReturnValue . . . . . . . . . . . . 131 ErrorConditions . . . . . . . . . . . 146

ErrorConditions . . . . . . . . . . . 131 ErrorMessages. . . . . . . . . . . . 146

ErrorMessages. . . . . . . . . . . . 131 RelatedInformation . . . . . . . . . . 146

RelatedInformation . . . . . . . . . . 131 ldap_parse_sort_control()—RetrieveValuesina

ldap_next_reference()—Retrievethenext SortedResultsControl . . . . . . . . . . 147

ContinuationReferenceinaChainofSearch AuthoritiesandLocks . . . . . . . . . 147

Results . . . . . . . . . . . . . . . 132 Parameters . . . . . . . . . . . . . 147

AuthoritiesandLocks . . . . . . . . . 132 ReturnValue . . . . . . . . . . . . 147

Parameters . . . . . . . . . . . . . 132 RelatedInformation . . . . . . . . . . 147

ReturnValue . . . . . . . . . . . . 132 ldap_perror()—PrintLDAPErrorInformation . . 148

ErrorConditions . . . . . . . . . . . 132 AuthoritiesandLocks . . . . . . . . . 148

ErrorMessages. . . . . . . . . . . . 132 Parameters . . . . . . . . . . . . . 148

RelatedInformation . . . . . . . . . . 133 ReturnValue . . . . . . . . . . . . 148

ldap_open()—PerformanLDAPOpenOperation 133 ErrorConditions . . . . . . . . . . . 149

AuthoritiesandLocks . . . . . . . . . 134 ErrorMessages. . . . . . . . . . . . 149

Parameters . . . . . . . . . . . . . 134 RelatedInformation . . . . . . . . . . 149

ReturnValue . . . . . . . . . . . . 135 ldap_pwdpolicy_err2string()—Convertthe

ErrorConditions . . . . . . . . . . . 135 NumericLDAPPasswordPolicyErrororWarning

ErrorMessages. . . . . . . . . . . . 135 CodeintoaString. . . . . . . . . . . . 149

RelatedInformation . . . . . . . . . . 135 AuthoritiesandLocks . . . . . . . . . 149

ldap_parse_extended_result()—Parseextended Parameters . . . . . . . . . . . . . 150

result . . . . . . . . . . . . . . . . 136 ReturnValue . . . . . . . . . . . . 150

AuthoritiesandLocks . . . . . . . . . 136 ErrorConditions . . . . . . . . . . . 150

Parameters . . . . . . . . . . . . . 136 ErrorMessages. . . . . . . . . . . . 150

ReturnValue . . . . . . . . . . . . 137 RelatedInformation . . . . . . . . . . 150

ErrorConditions . . . . . . . . . . . 137 ldap_remove_control()—RemoveaControlfrom

ErrorMessages. . . . . . . . . . . . 137 theListofLDAPServerControls. . . . . . . 151

RelatedInformation . . . . . . . . . . 137 AuthoritiesandLocks . . . . . . . . . 151

ldap_parse_page_control()—RetrieveValuesina Parameters . . . . . . . . . . . . . 151

PagedResultsControl . . . . . . . . . . 138 ReturnValue . . . . . . . . . . . . 151

AuthoritiesandLocks . . . . . . . . . 138 RelatedInformation . . . . . . . . . . 151

Parameters . . . . . . . . . . . . . 138 ldap_rename()—AsynchronouslyRenameanEntry 152

ReturnValue . . . . . . . . . . . . 138 AuthoritiesandLocks . . . . . . . . . 152

RelatedInformation . . . . . . . . . . 139 Parameters . . . . . . . . . . . . . 152

ldap_parse_pwdpolicy_response()—Obtainthe ReturnValue . . . . . . . . . . . . 153

LDAPPasswordPolicyErrororWarningCodes. . 140 ErrorConditions . . . . . . . . . . . 153

AuthoritiesandLocks . . . . . . . . . 140 ErrorMessages. . . . . . . . . . . . 153

Parameters . . . . . . . . . . . . . 140 RelatedInformation . . . . . . . . . . 153

ErrorConditions . . . . . . . . . . . 141 ldap_rename_s()—SynchronouslyRenameanEntry 154

RelatedInformation . . . . . . . . . . 141 AuthoritiesandLocks . . . . . . . . . 154

ldap_parse_reference_np()—ExtractInformation Parameters . . . . . . . . . . . . . 154

fromaContinuationReference . . . . . . . 141 ReturnValue . . . . . . . . . . . . 155

AuthoritiesandLocks . . . . . . . . . 142 ErrorConditions . . . . . . . . . . . 155

Parameters . . . . . . . . . . . . . 142 ErrorMessages. . . . . . . . . . . . 155

ReturnValue . . . . . . . . . . . . 142 RelatedInformation . . . . . . . . . . 155

ErrorConditions . . . . . . . . . . . 142 ldap_result()—RetrieveResultofanAsynchronous

ErrorMessages. . . . . . . . . . . . 142 LDAPOperation . . . . . . . . . . . . 156

viii iSeries: LightweightDirectoryAccessProtocol(LDAP)APIs