FieldsMethodsMember Objects1. Fields
name
| Function name |
Function signature |
| ldap_connector_name_get |
string ldap_connector_name_get (object:ldap_connector obj) |
|
This funcion returns the name of the ldap connector
|
| ldap_connector_name_set |
int ldap_connector_name_set (object:ldap_connector obj, string value) |
|
This function sets the name of the ldap connector. Returns 0 on succes, -1 on failure
|
password_field
| Function name |
Function signature |
| ldap_connector_password_field_get |
string ldap_connector_password_field_get (object:ldap_connector obj) |
|
This function returns the name of the ldap field containing the password
|
| ldap_connector_password_field_set |
int ldap_connector_password_field_set (object:ldap_connector obj, string value) |
|
This function sets the name of the ldap field containing the user's password. Returns 0 on succes, -1 on failure
|
search_base
| Function name |
Function signature |
| ldap_connector_search_base_set |
int ldap_connector_search_base_set (object:ldap_connector obj, string value) |
|
This function sets the location where to search for the user. Returns 0 on succes, -1 on failure
|
| ldap_connector_search_base_get |
string ldap_connector_search_base_get (object:ldap_connector obj) |
|
This function returs the location where to search for the user
|
axigen_host_field
| Function name |
Function signature |
| ldap_connector_axigen_host_field_set |
int ldap_connector_axigen_host_field_set (object:ldap_connector obj, string value) |
|
This function sets the name of the ldap field containing the user's Axigen hostname. Returns 0 on succes, -1 on failure
|
| ldap_connector_axigen_host_field_get |
string ldap_connector_axigen_host_field_get (object:ldap_connector obj) |
|
This function returns the name of the ldap field containing the user's Axigen hostname
|
bind_dn
| Function name |
Function signature |
| ldap_connector_bind_dn_get |
string ldap_connector_bind_dn_get (object:ldap_connector obj) |
|
This function returns the distinguished name used for binding
|
| ldap_connector_bind_dn_set |
int ldap_connector_bind_dn_set (object:ldap_connector obj, string value) |
|
This function sets the distinguished name used for binding. Returns 0 on succes, -1 on failure
|
use_first
| Function name |
Function signature |
| ldap_connector_use_first_get |
int ldap_connector_use_first_get (object:ldap_connector obj) |
|
This function returns 1 if the first result in a ldap search query should be used at 0 otherwise
|
| ldap_connector_use_first_set |
int ldap_connector_use_first_set (object:ldap_connector obj, int value) |
|
If the 'value' parameter is 1, the ldap connector uses only the first result from the ldap query, otherwise, if it is needed, will search through others. Returns 0 on succes, -1 on failure
|
search_pattern
| Function name |
Function signature |
| ldap_connector_search_pattern_get |
string ldap_connector_search_pattern_get (object:ldap_connector obj) |
|
This function returns the user search pattern
|
| ldap_connector_search_pattern_set |
int ldap_connector_search_pattern_set (object:ldap_connector obj, string value) |
|
This function sets the user search pattern. Returns 0 on succes, -1 on failure
|
hosturl
| Function name |
Function signature |
| ldap_connector_hosturl_set |
int ldap_connector_hosturl_set (object:ldap_connector obj, string value) |
|
This funtion sets the address for the ldap connector. Returns 0 on succes, -1 on failure
|
| ldap_connector_hosturl_get |
string ldap_connector_hosturl_get (object:ldap_connector obj) |
|
This function returns the address (host url) of the ldap connector
|
bind_pass
| Function name |
Function signature |
| ldap_connector_bind_pass_get |
string ldap_connector_bind_pass_get (object:ldap_connector obj) |
|
This function returns the password used for binding
|
| ldap_connector_bind_pass_set |
int ldap_connector_bind_pass_set (object:ldap_connector obj, string value) |
|
This function sets the password used for binding. Returns 0 on succes, -1 on failure
|
2. Methods
| Function name |
Function signature |
| ldap_connector_save |
int ldap_connector_save (object:ldap_connector data, object:session session) |
|
This function saves the configuration of the ldap connector object back to Axigen
|
| ldap_connector_load |
object:ldap_connector ldap_connector_load (object:session s, object:context_list context) |
| ldap_connector_destroy |
int ldap_connector_destroy (void* data) |
3. Member Objects
listeners
Functions that apply to member object:
| Function name |
Function signature |
| imap_listeners_get |
object:listeners imap_listeners_get (object:imap imap, object:session s) |
|
This function returns the listener list of this service
|
