LDAP functions

There are a number of built-in LDAP script functions that can be used to connect to a directory server, retrieve information from a user directory, add entries to a user directory, etc..

Figure 3

Connection to a directory server.

Escape sequences

The less-than sign (<) is a reserved character and must be escaped if used in a string. See Escape sequences.

LDAP functions

The table below contains a short description of each script function. For information about syntax, examples, etc., see the full description of each script function.

Function name	Description
LdapAddAttrBinaryValue	Takes the entryID (returned by the LdapGetEntry function), the attribute name, and a filename, and adds the contents of the file to the given attribute.
LdapAddAttrValue	Adds the specified value to the specified attribute. The changes are not written to the directory until the LdapUpdateEntry function is called.
LdapConnect	Connects to the directory server.
LdapConnectPersistent	Connects to the directory server.
LdapConnectSSL	Connects to the directory server using an encrypted connection.
LdapConnectSSLCCA	Connects to the directory server using an encrypted connection. A Client Certificate Authentication is provided instead of user/password authentication.
LdapConnectSSLCCAPersistent	Connects to the directory server using an encrypted connection. A Client Certificate Authentication is provided instead of user/password authentication.
LdapConnectSSLPersistent	Connects to the directory server using an encrypted connection.
LdapDisconnect	Disconnects the from the directory server.
LdapFind	Finds entries in the LDAP directory using an LDAP query.
LdapGetAttrValue	Retrieves a value from a specific attribute on an entry.
LdapGetAttrValueCount	Returns the number of values of a specific attribute on an entry.
LdapGetEntry	Retrieves a specific entry from a result set (the result of a query).
LdapGetEntryCount	Returns the number of entries associated with a resultID.
LdapGetObjectByDN	Searches the LDAP directory for a specific object.
LdapGetUser	Searches the LDAP directory for a specific user.
LdapNewEntry	Creates a new entry in the LDAP directory. Changes are not written to the directory until the LdapUpdateEntry function is called.
LdapReleaseNewEntries	To decrease the memory usage, you can call this function which releases memory allocated for all new entries created by LdapNewEntry function calls.
LdapReleaseResultSet	To decrease the memory usage, you can call this function which frees result sets that are returned from ldapFind, ldapGetUser, and ldapGetObjectByDN function calls.
LdapReplaceAttrBinaryValue	Takes the entryID (as returned by LdapGetEntry), the attribute name, and a filename, and adds the contents of the file to the given attribute.
LdapReplaceAttrValue	Replaces the value(s) of an attribute with another value.
LdapSort	Sorts entries in a result set based on one or more entry attributes.
LdapUpdateEntry	Writes any changes that have been made to an entry back to the LDAP server.
LdapWriteAttrBinaryValue	Writes the contents of the attribute to a file.