LDAP Class

Properties   Methods   Events   Config Settings   Errors  

The Lightweight Directory Access Protocol (LDAP) Class is used to search, manage, and maintain internet directory servers.

Syntax

LDAP

Remarks

The LDAP Class supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over SSL/TLS the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL related settings are also supported via the Config method.

The LDAP Class implements a standard LDAP client as specified in RFC 1777, 2251, and other LDAP RFCs. Support for both LDAP v2 and v3 is provided.

The first step in using the class is specifying the ServerName, a DN (distinguished name) to bind as, and optionally a Password. Then you can call one or more of the class methods to act upon the server. Server responses normally are received through the Result event. The only exceptions are search requests that result in one or more SearchResult events, followed by a final SearchComplete event.

Attributes are set and returned through the Attributes properties. Other command arguments are specified through other properties. These are specified in detail in each method.

Search filters are to be specified as string arguments to the Search method. The format must be a standard LDAP search string as specified in RFC 1558. Other search attributes are set in properties, such as SearchScope, SearchTimeLimit, SearchSizeLimit, SearchReturnValues, and SearchDerefAliases.

The class operates synchronously by default (waits for a response before returning control to the caller); however, the class also may operate asynchronously (return control immediately), by setting Timeout to 0. Please refer to the Timeout property for more information.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

AcceptData Property (LDAP Class)

This property enables or disables data reception from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAcceptData();
int SetAcceptData(int bAcceptData);

Unicode (Windows)
BOOL GetAcceptData();
INT SetAcceptData(BOOL bAcceptData);

int ipworksauth_ldap_getacceptdata(void* lpObj);
int ipworksauth_ldap_setacceptdata(void* lpObj, int bAcceptData);

bool GetAcceptData();
int SetAcceptData(bool bAcceptData);

Default Value

TRUE

Remarks

This property enables or disables data reception from the server. Setting the property to False, temporarily disables data reception. Setting the property to True, reenables data reception.

Note: It is recommended to use the PauseData or ProcessData method instead of setting this property.

This property is not available at design time.

Data Type

Boolean

AttrCount Property (LDAP Class)

The number of records in the Attr arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAttrCount();
int SetAttrCount(int iAttrCount);

Unicode (Windows)
INT GetAttrCount();
INT SetAttrCount(INT iAttrCount);

int ipworksauth_ldap_getattrcount(void* lpObj);
int ipworksauth_ldap_setattrcount(void* lpObj, int iAttrCount);

int GetAttrCount();
int SetAttrCount(int iAttrCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttrModOp
• AttrType
• AttrValue

The array indices start at 0 and end at AttrCount - 1.

This property is not available at design time.

Data Type

Integer

AttrType Property (LDAP Class)

This property contains the attribute type for the current entry.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttrType(int iAttrIndex);
int SetAttrType(int iAttrIndex, const char* lpszAttrType);

Unicode (Windows)
LPWSTR GetAttrType(INT iAttrIndex);
INT SetAttrType(INT iAttrIndex, LPCWSTR lpszAttrType);

char* ipworksauth_ldap_getattrtype(void* lpObj, int attrindex);
int ipworksauth_ldap_setattrtype(void* lpObj, int attrindex, const char* lpszAttrType);

QString GetAttrType(int iAttrIndex);
int SetAttrType(int iAttrIndex, QString qsAttrType);

Default Value

""

Remarks

This property contains the attribute type for the current entry.

If the value of AttributeType is an empty string, then the AttrValue that contains the corresponding value is part of a set of values, and the attribute type for the set is specified in the previous attribute of the properties with a nonempty AttributeType.

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

This property is not available at design time.

Data Type

String

AttrModOp Property (LDAP Class)

This property contains an operation to apply to attributes during a Lightweight Directory Access Protocol (LDAP) modify operation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAttrModOp(int iAttrIndex);
int SetAttrModOp(int iAttrIndex, int iAttrModOp);

Unicode (Windows)
INT GetAttrModOp(INT iAttrIndex);
INT SetAttrModOp(INT iAttrIndex, INT iAttrModOp);

AMO_ADD(0), 
AMO_DELETE(1), 
AMO_REPLACE(2)

int ipworksauth_ldap_getattrmodop(void* lpObj, int attrindex);
int ipworksauth_ldap_setattrmodop(void* lpObj, int attrindex, int iAttrModOp);

int GetAttrModOp(int iAttrIndex);
int SetAttrModOp(int iAttrIndex, int iAttrModOp);

Default Value

0

Remarks

This property contains an operation to apply to attributes during a Lightweight Directory Access Protocol (LDAP) modify operation.

Possible values include the following:

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

This property is not available at design time.

Data Type

Integer

AttrValue Property (LDAP Class)

This property contains the attribute value for the current entry.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAttrValue(int iAttrIndex, char* &lpAttrValue, int &lenAttrValue);
int SetAttrValue(int iAttrIndex, const char* lpAttrValue, int lenAttrValue);

Unicode (Windows)
INT GetAttrValue(INT iAttrIndex, LPSTR &lpAttrValue, INT &lenAttrValue);
INT SetAttrValue(INT iAttrIndex, LPCSTR lpAttrValue, INT lenAttrValue);

int ipworksauth_ldap_getattrvalue(void* lpObj, int attrindex, char** lpAttrValue, int* lenAttrValue);
int ipworksauth_ldap_setattrvalue(void* lpObj, int attrindex, const char* lpAttrValue, int lenAttrValue);

QByteArray GetAttrValue(int iAttrIndex);
int SetAttrValue(int iAttrIndex, QByteArray qbaAttrValue);

Default Value

""

Remarks

This property contains the attribute value for the current entry.

If the value is part of a set of values, the AttributeType that contains the corresponding attribute type is an empty string, and the attribute type for the set is specified in the previous attribute of the properties with a nonempty AttributeType.

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

This property is not available at design time.

Data Type

Binary String

AuthMechanism Property (LDAP Class)

This property is the authentication mechanism to be used when connecting to the Lightweight Directory Access Protocol (LDAP) server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthMechanism();
int SetAuthMechanism(int iAuthMechanism);

Unicode (Windows)
INT GetAuthMechanism();
INT SetAuthMechanism(INT iAuthMechanism);

LAM_SIMPLE(0), 
LAM_DIGEST_MD5(1), 
LAM_NEGOTIATE(2), 
LAM_KERBEROS(6), 
LAM_SASLEXTERNAL(7)

int ipworksauth_ldap_getauthmechanism(void* lpObj);
int ipworksauth_ldap_setauthmechanism(void* lpObj, int iAuthMechanism);

int GetAuthMechanism();
int SetAuthMechanism(int iAuthMechanism);

Default Value

0

Remarks

This property specifies the authentication mechanism used. Possible values are as follows:

Data Type

Integer

Connected Property (LDAP Class)

This shows whether the class is connected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();
int SetConnected(int bConnected);

Unicode (Windows)
BOOL GetConnected();
INT SetConnected(BOOL bConnected);

int ipworksauth_ldap_getconnected(void* lpObj);
int ipworksauth_ldap_setconnected(void* lpObj, int bConnected);

bool GetConnected();
int SetConnected(bool bConnected);

Default Value

FALSE

Remarks

This property is used to determine whether or not the class is connected to the remote host.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

Data Type

Boolean

DeleteOldRDN Property (LDAP Class)

This property controls whether the old RDN (Relative Distinguished Name) should be deleted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDeleteOldRDN();
int SetDeleteOldRDN(int bDeleteOldRDN);

Unicode (Windows)
BOOL GetDeleteOldRDN();
INT SetDeleteOldRDN(BOOL bDeleteOldRDN);

int ipworksauth_ldap_getdeleteoldrdn(void* lpObj);
int ipworksauth_ldap_setdeleteoldrdn(void* lpObj, int bDeleteOldRDN);

bool GetDeleteOldRDN();
int SetDeleteOldRDN(bool bDeleteOldRDN);

Default Value

TRUE

Remarks

This property controls whether the old RDN should be deleted. It is used when ModifyRDN is called. The default value is True, which instructs the server to delete the old RDN.

This property is not available at design time.

Data Type

Boolean

DN Property (LDAP Class)

This property includes the distinguished name used as the base for Lightweight Directory Access Protocol (LDAP) operations.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDN();
int SetDN(const char* lpszDN);

Unicode (Windows)
LPWSTR GetDN();
INT SetDN(LPCWSTR lpszDN);

char* ipworksauth_ldap_getdn(void* lpObj);
int ipworksauth_ldap_setdn(void* lpObj, const char* lpszDN);

QString GetDN();
int SetDN(QString qsDN);

Default Value

""

Remarks

This also includes the base object during LDAP searches.

The distinguished name is provided in string format, as specified by RFC 1779. Example. Setting DN:

LDAPControl.DN = "uid=TThompson,ou=Employees,dc=server" LDAPControl.DN = "Domain\Username"

Data Type

String

FirewallAutoDetect Property (LDAP Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

int ipworksauth_ldap_getfirewallautodetect(void* lpObj);
int ipworksauth_ldap_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (LDAP Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

int ipworksauth_ldap_getfirewalltype(void* lpObj);
int ipworksauth_ldap_setfirewalltype(void* lpObj, int iFirewallType);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (LDAP Class)

This property contains the name or IP address of firewall (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

char* ipworksauth_ldap_getfirewallhost(void* lpObj);
int ipworksauth_ldap_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (LDAP Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

char* ipworksauth_ldap_getfirewallpassword(void* lpObj);
int ipworksauth_ldap_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (LDAP Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

int ipworksauth_ldap_getfirewallport(void* lpObj);
int ipworksauth_ldap_setfirewallport(void* lpObj, int iFirewallPort);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (LDAP Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

char* ipworksauth_ldap_getfirewalluser(void* lpObj);
int ipworksauth_ldap_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

Idle Property (LDAP Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int ipworksauth_ldap_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

LDAPVersion Property (LDAP Class)

The version of the Lightweight Directory Access Protocol (LDAP) used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLDAPVersion();
int SetLDAPVersion(int iLDAPVersion);

Unicode (Windows)
INT GetLDAPVersion();
INT SetLDAPVersion(INT iLDAPVersion);

int ipworksauth_ldap_getldapversion(void* lpObj);
int ipworksauth_ldap_setldapversion(void* lpObj, int iLDAPVersion);

int GetLDAPVersion();
int SetLDAPVersion(int iLDAPVersion);

Default Value

3

Remarks

This property contains the version of LDAP used. The default value is 3 (for LDAPv3).

This property is not available at design time.

Data Type

Integer

LocalHost Property (LDAP Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworksauth_ldap_getlocalhost(void* lpObj);
int ipworksauth_ldap_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

MessageId Property (LDAP Class)

This property includes the message identifier for the next Lightweight Directory Access Protocol (LDAP) request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageId();
int SetMessageId(int iMessageId);

Unicode (Windows)
INT GetMessageId();
INT SetMessageId(INT iMessageId);

int ipworksauth_ldap_getmessageid(void* lpObj);
int ipworksauth_ldap_setmessageid(void* lpObj, int iMessageId);

int GetMessageId();
int SetMessageId(int iMessageId);

Default Value

1

Remarks

This property contains the message identifier for the next LDAP request. If a custom value is needed, this property must be set before calling any other methods. The class increments this property automatically after each request.

This property is not available at design time.

Data Type

Integer

PageSize Property (LDAP Class)

This property includes the maximum number of results per page for the Search method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPageSize();
int SetPageSize(int iPageSize);

Unicode (Windows)
INT GetPageSize();
INT SetPageSize(INT iPageSize);

int ipworksauth_ldap_getpagesize(void* lpObj);
int ipworksauth_ldap_setpagesize(void* lpObj, int iPageSize);

int GetPageSize();
int SetPageSize(int iPageSize);

Default Value

0

Remarks

This property contains the maximum number of results per page for the Search method. The default value is 0 (no paging). If set to a value greater than zero, results will be paged, that is, returned in blocks of maximum PageSize results.

For each page sent by the server, a SearchPage event will fire. You may decide to cancel or continue displaying results from within this event.

Note: Lightweight Directory Access Protocol (LDAP) paging functionality is described by LDAP extension RFCs and may or may not be implemented by the LDAP server being accessed.

Data Type

Integer

Password Property (LDAP Class)

This property includes the password used to authenticate to the Lightweight Directory Access Protocol (LDAP) server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* ipworksauth_ldap_getpassword(void* lpObj);
int ipworksauth_ldap_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

""

Remarks

This property contains the password used to authenticate to the LDAP server. Leave this value empty if no password is required.

This property is not available at design time.

Data Type

String

ReferenceCount Property (LDAP Class)

The number of records in the Reference arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReferenceCount();

Unicode (Windows)
INT GetReferenceCount();

int ipworksauth_ldap_getreferencecount(void* lpObj);

int GetReferenceCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• ReferenceURL

The array indices start at 0 and end at ReferenceCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ReferenceURL Property (LDAP Class)

The url of the LDAP reference.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReferenceURL(int iReferenceIndex);

Unicode (Windows)
LPWSTR GetReferenceURL(INT iReferenceIndex);

char* ipworksauth_ldap_getreferenceurl(void* lpObj, int referenceindex);

QString GetReferenceURL(int iReferenceIndex);

Default Value

""

Remarks

The url of the LDAP reference. If inside a SearchResult or SearchResultReference event, it represents a URL to contact to continue the search. If inside the Result event or SearchComplete event it represents the URL to contact in order to complete the requested operation.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only and not available at design time.

Data Type

String

ResultCode Property (LDAP Class)

This property includes the result code returned in the last server response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetResultCode();

Unicode (Windows)
INT GetResultCode();

int ipworksauth_ldap_getresultcode(void* lpObj);

int GetResultCode();

Default Value

0

Remarks

This property contains the result code returned in the last server response. This is identical to the corresponding parameter provided by the last Result, SearchResult, or SearchComplete event.

Possible result codes are as follows:

All the result codes with the exception of success, compareFalse and compareTrue are to be treated as meaning the operation could not be completed in its entirety. Result codes from 16 to 21 indicate an AttributeProblem; codes 32, 33, 34, and 36 indicate a NameProblem; codes 48, 49, and 50 indicate a SecurityProblem; codes 51 to 54 indicate a ServiceProblem; and codes 64 to 69 and 71 indicate an UpdateProblem.

This property is read-only.

Data Type

Integer

ResultDescription Property (LDAP Class)

This property includes the descriptive text returned in the last server response (if any).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResultDescription();

Unicode (Windows)
LPWSTR GetResultDescription();

char* ipworksauth_ldap_getresultdescription(void* lpObj);

QString GetResultDescription();

Default Value

""

Remarks

This property contains the descriptive text returned in the last server response (if any). This is identical to the corresponding parameter provided by the last Result, SearchResult, or SearchComplete event.

This property is read-only.

Data Type

String

ResultDN Property (LDAP Class)

This property includes the distinguished name returned in the last server response (if any).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResultDN();

Unicode (Windows)
LPWSTR GetResultDN();

char* ipworksauth_ldap_getresultdn(void* lpObj);

QString GetResultDN();

Default Value

""

Remarks

This property contains the distinguished name returned in the last server response (if any). This is identical to the corresponding parameter provided by the last Result or SearchComplete event.

This property is read-only.

Data Type

String

SearchDerefAliases Property (LDAP Class)

This property controls alias dereferencing during searching.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSearchDerefAliases();
int SetSearchDerefAliases(int iSearchDerefAliases);

Unicode (Windows)
INT GetSearchDerefAliases();
INT SetSearchDerefAliases(INT iSearchDerefAliases);

SDA_NEVER(0), 
SDA_IN_SEARCHING(1), 
SDA_FINDING_BASE_OBJECT(2), 
SDA_ALWAYS(3)

int ipworksauth_ldap_getsearchderefaliases(void* lpObj);
int ipworksauth_ldap_setsearchderefaliases(void* lpObj, int iSearchDerefAliases);

int GetSearchDerefAliases();
int SetSearchDerefAliases(int iSearchDerefAliases);

Default Value

0

Remarks

This property controls the alias dereferencing during searching. The possible values are as follows:

The default is to never dereference aliases.

Data Type

Integer

SearchReturnValues Property (LDAP Class)

This property controls whether the search operation returns values of attributes or only types.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSearchReturnValues();
int SetSearchReturnValues(int bSearchReturnValues);

Unicode (Windows)
BOOL GetSearchReturnValues();
INT SetSearchReturnValues(BOOL bSearchReturnValues);

int ipworksauth_ldap_getsearchreturnvalues(void* lpObj);
int ipworksauth_ldap_setsearchreturnvalues(void* lpObj, int bSearchReturnValues);

bool GetSearchReturnValues();
int SetSearchReturnValues(bool bSearchReturnValues);

Default Value

TRUE

Remarks

This property controls whether the search operation returns values of attributes or only types. If only attributes are needed, disabling the property to return values will enhance performance.

Data Type

Boolean

SearchScope Property (LDAP Class)

This property controls the scope of Lightweight Directory Access Protocol (LDAP) search operations.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSearchScope();
int SetSearchScope(int iSearchScope);

Unicode (Windows)
INT GetSearchScope();
INT SetSearchScope(INT iSearchScope);

SS_BASE_OBJECT(0), 
SS_SINGLE_LEVEL(1), 
SS_WHOLE_SUBTREE(2)

int ipworksauth_ldap_getsearchscope(void* lpObj);
int ipworksauth_ldap_setsearchscope(void* lpObj, int iSearchScope);

int GetSearchScope();
int SetSearchScope(int iSearchScope);

Default Value

2

Remarks

This property controls the scope of LDAP search operations. Possible values are as follows:

The default is to search the whole subtree.

Data Type

Integer

SearchSizeLimit Property (LDAP Class)

This property includes the maximum number of entries that can be returned by the next search operation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSearchSizeLimit();
int SetSearchSizeLimit(int iSearchSizeLimit);

Unicode (Windows)
INT GetSearchSizeLimit();
INT SetSearchSizeLimit(INT iSearchSizeLimit);

int ipworksauth_ldap_getsearchsizelimit(void* lpObj);
int ipworksauth_ldap_setsearchsizelimit(void* lpObj, int iSearchSizeLimit);

int GetSearchSizeLimit();
int SetSearchSizeLimit(int iSearchSizeLimit);

Default Value

0

Remarks

This property contains the maximum number of entries that can be returned by the next search operation. This limit is provided as a hint to the directory server. A value of 0 means that no size limits are in effect for the search.

Data Type

Integer

SearchTimeLimit Property (LDAP Class)

This property includes a time limit for the next search operation (in seconds).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSearchTimeLimit();
int SetSearchTimeLimit(int iSearchTimeLimit);

Unicode (Windows)
INT GetSearchTimeLimit();
INT SetSearchTimeLimit(INT iSearchTimeLimit);

int ipworksauth_ldap_getsearchtimelimit(void* lpObj);
int ipworksauth_ldap_setsearchtimelimit(void* lpObj, int iSearchTimeLimit);

int GetSearchTimeLimit();
int SetSearchTimeLimit(int iSearchTimeLimit);

Default Value

0

Remarks

This property contains a time limit for the next search operation (in seconds). This limit is provided as a hint to the directory server. A value of 0 means that no time limits are in effect for the search.

Data Type

Integer

ServerName Property (LDAP Class)

This property includes the name or address of the Lightweight Directory Access Protocol (LDAP) server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerName();
int SetServerName(const char* lpszServerName);

Unicode (Windows)
LPWSTR GetServerName();
INT SetServerName(LPCWSTR lpszServerName);

char* ipworksauth_ldap_getservername(void* lpObj);
int ipworksauth_ldap_setservername(void* lpObj, const char* lpszServerName);

QString GetServerName();
int SetServerName(QString qsServerName);

Default Value

""

Remarks

This property specifies the IP address (IP number in dotted internet format) or the domain name of the directory server. It is set before a connection is attempted and cannot be changed once a connection is in progress.

If this property is set to a domain name, a DNS request is initiated, and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ServerPort Property (LDAP Class)

This property includes the server port for the Lightweight Directory Access Protocol (LDAP) connection (the default is 389).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerPort();
int SetServerPort(int iServerPort);

Unicode (Windows)
INT GetServerPort();
INT SetServerPort(INT iServerPort);

int ipworksauth_ldap_getserverport(void* lpObj);
int ipworksauth_ldap_setserverport(void* lpObj, int iServerPort);

int GetServerPort();
int SetServerPort(int iServerPort);

Default Value

389

Remarks

This property contains the server port for the LDAP connection (the default is 389).

For the implicit Secure Sockets Layer (SSL), use port 636 (please refer to the SSLStartMode property for more information).

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

This property is not available at design time.

Data Type

Integer

SortAttributes Property (LDAP Class)

This property includes a string of attribute names to sort on with optional relative matching rules.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSortAttributes();
int SetSortAttributes(const char* lpszSortAttributes);

Unicode (Windows)
LPWSTR GetSortAttributes();
INT SetSortAttributes(LPCWSTR lpszSortAttributes);

char* ipworksauth_ldap_getsortattributes(void* lpObj);
int ipworksauth_ldap_setsortattributes(void* lpObj, const char* lpszSortAttributes);

QString GetSortAttributes();
int SetSortAttributes(QString qsSortAttributes);

Default Value

""

Remarks

This property contains a string of attribute names to sort on with optional relative matching rules. When set before a Search, entries returned by the server will be sorted according to SortAttributes. The format consists of one or more attribute names separated by spaces. Each attribute may be followed by an optional matching rule.

If matching rules are defined, they should be separated from the attribute names with a "/".

Normally, the values are returned in ascending order. If descending (reverse) order of sorting is desired, the attribute type must be preceded with a "-".

Following are examples:

LDAPControl.SortAttributes = "loginTime" LDAPControl.SortAttributes = "name/caseIgnoreSubstringsMatch age/numericStringSubstringsMatch" LDAPControl.SortAttributes = "cn age/1.3.6.1.4.1.1466.115.121.1.27" LDAPControl.SortAttributes = "-cn age/1.3.6.1.4.1.1466.115.121.1.27" Example 1. Matching Rules for Equality Filters:

Data Type

String

SSLAcceptServerCertEncoded Property (LDAP Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int ipworksauth_ldap_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksauth_ldap_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (LDAP Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int ipworksauth_ldap_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksauth_ldap_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (LDAP Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int ipworksauth_ldap_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksauth_ldap_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (LDAP Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* ipworksauth_ldap_getsslcertstorepassword(void* lpObj);
int ipworksauth_ldap_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (LDAP Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksauth_ldap_getsslcertstoretype(void* lpObj);
int ipworksauth_ldap_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (LDAP Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* ipworksauth_ldap_getsslcertsubject(void* lpObj);
int ipworksauth_ldap_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLEnabled Property (LDAP Class)

Whether TLS/SSL is enabled.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLEnabled();
int SetSSLEnabled(int bSSLEnabled);

Unicode (Windows)
BOOL GetSSLEnabled();
INT SetSSLEnabled(BOOL bSSLEnabled);

int ipworksauth_ldap_getsslenabled(void* lpObj);
int ipworksauth_ldap_setsslenabled(void* lpObj, int bSSLEnabled);

bool GetSSLEnabled();
int SetSSLEnabled(bool bSSLEnabled);

Default Value

FALSE

Remarks

This setting specifies whether TLS/SSL is enabled in the class. When False (default) the class operates in plaintext mode. When True TLS/SSL is enabled.

TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.

This property is not available at design time.

Data Type

Boolean

SSLProvider Property (LDAP Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int ipworksauth_ldap_getsslprovider(void* lpObj);
int ipworksauth_ldap_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (LDAP Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

int ipworksauth_ldap_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Binary String

SSLStartMode Property (LDAP Class)

Determines how the class starts the SSL negotiation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLStartMode();
int SetSSLStartMode(int iSSLStartMode);

Unicode (Windows)
INT GetSSLStartMode();
INT SetSSLStartMode(INT iSSLStartMode);

SSL_AUTOMATIC(0), 
SSL_IMPLICIT(1), 
SSL_EXPLICIT(2), 
SSL_NONE(3)

int ipworksauth_ldap_getsslstartmode(void* lpObj);
int ipworksauth_ldap_setsslstartmode(void* lpObj, int iSSLStartMode);

int GetSSLStartMode();
int SetSSLStartMode(int iSSLStartMode);

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Data Type

Integer

Timeout Property (LDAP Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int ipworksauth_ldap_gettimeout(void* lpObj);
int ipworksauth_ldap_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

If the Timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If Timeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

Abandon Method (LDAP Class)

This method asks the server to abandon a request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Abandon(int iMessageId);

Unicode (Windows)
INT Abandon(INT iMessageId);

int ipworksauth_ldap_abandon(void* lpObj, int iMessageId);

int Abandon(int iMessageId);

Remarks

This method asks the server to abandon the request specified by MessageId. The result of the operation is returned through the Result event.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Add Method (LDAP Class)

This method adds an entry specified by DN to the directory server using the type and value attributes defined in the Attributes properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Add();

Unicode (Windows)
INT Add();

int ipworksauth_ldap_add(void* lpObj);

int Add();

Remarks

This method adds the entry specified by DN to the directory. All entries are required to have an objectClass attribute.

To add a new entry, first Bind with credentials that will allow you to perform the new addition. To add attributes instead of entries, use the Modify method instead. When specifying multivalued attributes, specify the attribute type only in the first occurrence of that attribute type in the Attributes properties. Additional instances of the same attribute type should specify an attribute type of an empty string.

The result of the operation is returned through the Result event.

Example. Add a New Entry (including the multivalued objectClass attribute):

LDAPControl.DN = "uid=NewUser,ou=Employees,dc=server" LDAPControl.AttributeCount = 7 LDAPControl.AttributeType(0) = "objectClass" LDAPControl.AttributeValue(0) = "top" LDAPControl.AttributeType(1) = "" LDAPControl.AttributeValue(1) = "person" LDAPControl.AttributeType(2) = "" LDAPControl.AttributeValue(2) = "organizationalPerson" LDAPControl.AttributeType(3) = "" LDAPControl.AttributeValue(3) = "inetOrgPerson" LDAPControl.AttributeType(4) = "sn" LDAPControl.AttributeValue(4) = "UserName" LDAPControl.AttributeType(5) = "cn" LDAPControl.AttributeValue(5) = "New S. UserName" LDAPControl.AttributeType(6) = "uid" LDAPControl.AttributeValue(6) = "NewUser" LDAPControl.Add()

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Attr Method (LDAP Class)

This method returns the value of the specified Lightweight Directory Access Protocol (LDAP) attribute.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Attr(const char* lpszAttrType);

Unicode (Windows)
LPWSTR Attr(LPCWSTR lpszAttrType);

char* ipworksauth_ldap_attr(void* lpObj, const char* lpszAttrType);

QString Attr(const QString& qsAttrType);

Remarks

This method returns the value of the specified LDAP attribute. If the attribute does not exist, an empty string is returned.

Please refer to the Attributes properties for more information.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Bind Method (LDAP Class)

This method connects and binds to the directory server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Bind();

Unicode (Windows)
INT Bind();

int ipworksauth_ldap_bind(void* lpObj);

int Bind();

Remarks

This method connects and binds to the directory server. If the Password property has a value, it is used for authentication. If not, the bind is performed anonymously. Binding is often required on some directory servers, like Active Directory. The result of the operation is returned through the Result event.

Example. Binding:

LDAPControl.DN = "uid=TThompson,ou=Employees,dc=server" LDAPControl.Password = "mypassword" LDAPControl.Bind() LDAPControl.DN = "Domain/Username" LDAPControl.Password = "mypassword" LDAPControl.Bind()

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ChangePassword Method (LDAP Class)

This method changes the password for the specified user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ChangePassword(const char* lpszuser, const char* lpszoldPassword, const char* lpsznewPassword);

Unicode (Windows)
INT ChangePassword(LPCWSTR lpszuser, LPCWSTR lpszoldPassword, LPCWSTR lpsznewPassword);

int ipworksauth_ldap_changepassword(void* lpObj, const char* lpszuser, const char* lpszoldPassword, const char* lpsznewPassword);

int ChangePassword(const QString& qsuser, const QString& qsoldPassword, const QString& qsnewPassword);

Remarks

This method changes the password for the specified user.

The User parameter is the name of the user for which the password will be changed. OldPassword specifies the current password and NewPassword specifies the new password.

Note: This operation can be performed only over the Secure Sockets Layer (SSL) port. Set ServerPort to the SSL port of the server (typically 636) before calling this method.

Note: If the user is an administrator, the old password is not required.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Compare Method (LDAP Class)

This method compares attributes and values with those of the entry specified by DN .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Compare();

Unicode (Windows)
INT Compare();

int ipworksauth_ldap_compare(void* lpObj);

int Compare();

Remarks

This method compares attribute types and values specified via the Attributes properties, with the values in the directory for the entry specified by DN. The result of the operation is returned through the Result event.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (LDAP Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksauth_ldap_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Connect Method (LDAP Class)

This method connects to the remote host without performing any action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Connect();

Unicode (Windows)
INT Connect();

int ipworksauth_ldap_connect(void* lpObj);

int Connect();

Remarks

This method establishes a connection with the remote host specified by URL, but it does not send a request. In most cases, it is recommended to use the appropriate method, such as Get or Post, which will both establish a connection and send a request.

This method may be useful in cases in which it is desirable to establish a connection without performing any operation (e.g., when testing connectivity).

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Delete Method (LDAP Class)

Deletes an entry specified by DN from the directory server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Delete();

Unicode (Windows)
INT Delete();

int ipworksauth_ldap_delete(void* lpObj);

int Delete();

Remarks

This method deletes the entry specified by DN from the directory. The result of the operation is returned through the Result event.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DoEvents Method (LDAP Class)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworksauth_ldap_doevents(void* lpObj);

int DoEvents();

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ExtendedRequest Method (LDAP Class)

This method performs a Lightweight Directory Access Protocol (LDAP) V3 extended operation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ExtendedRequest(const char* lpszRequestName, const char* lpRequestValue, int lenRequestValue);

Unicode (Windows)
INT ExtendedRequest(LPCWSTR lpszRequestName, LPCSTR lpRequestValue, INT lenRequestValue);

int ipworksauth_ldap_extendedrequest(void* lpObj, const char* lpszRequestName, const char* lpRequestValue, int lenRequestValue);

int ExtendedRequest(const QString& qsRequestName, QByteArray qbaRequestValue);

Remarks

This method performs an LDAP V3 extended operation. RequestName must contain the object identifier of the operation, and RequestValue may contain an optional value.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Interrupt Method (LDAP Class)

Interrupt the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworksauth_ldap_interrupt(void* lpObj);

int Interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListComputers Method (LDAP Class)

This method lists all computers in the directory.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListComputers();

Unicode (Windows)
INT ListComputers();

int ipworksauth_ldap_listcomputers(void* lpObj);

int ListComputers();

Remarks

This method lists all computers in the directory. The ComputerList event will be fired once for each computer returned.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListGroupMembers Method (LDAP Class)

This method lists all members of a group.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListGroupMembers(const char* lpszgroup);

Unicode (Windows)
INT ListGroupMembers(LPCWSTR lpszgroup);

int ipworksauth_ldap_listgroupmembers(void* lpObj, const char* lpszgroup);

int ListGroupMembers(const QString& qsgroup);

Remarks

This method lists all members of the specified group. The UserList event will be fired once for each member returned.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListGroups Method (LDAP Class)

This method list all groups in the directory.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListGroups();

Unicode (Windows)
INT ListGroups();

int ipworksauth_ldap_listgroups(void* lpObj);

int ListGroups();

Remarks

This method lists all groups in the directory. The GroupList event will be fired once for each group returned.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListUserGroups Method (LDAP Class)

This method lists all groups a user is a part of.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListUserGroups(const char* lpszuser);

Unicode (Windows)
INT ListUserGroups(LPCWSTR lpszuser);

int ipworksauth_ldap_listusergroups(void* lpObj, const char* lpszuser);

int ListUserGroups(const QString& qsuser);

Remarks

This method lists all groups that the user specified by user is a part of. The GroupList event will fire once for each group the user is a part of.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Modify Method (LDAP Class)

This method performs a Lightweight Directory Access Protocol (LDAP) modify operation on the entry specified by DN .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Modify();

Unicode (Windows)
INT Modify();

int ipworksauth_ldap_modify(void* lpObj);

int Modify();

Remarks

This method performs an LDAP modify operation on the entry specified by DN. The attributes to modify should be set via the Attributes properties. When specifying multivalued attributes, specify the attribute type only in the first occurrence of that attribute type in the Attributes properties. Additional instances of the same attribute type should specify an attribute type of an empty string.

The modification can be a replacement, an addition, or a deletion, depending on the ModOp field of the attribute;. The result of the operation is returned through the Result event.

Example. Modify an Entry (Replace an Attribute Value):

LDAPControl.DN = "uid=TThompson,ou=Employees,dc=server" LDAPControl.AttributeCount = 2 LDAPControl.AttributeType(0) = "url" LDAPControl.AttributeValue(0) = "www.url1.net" LDAPControl.AttributeModOp(0) = amoReplace LDAPControl.AttributeType(0) = "" LDAPControl.AttributeValue(0) = "www.url2.net" LDAPControl.AttributeModOp(0) = amoReplace LDAPControl.Modify()

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ModifyRDN Method (LDAP Class)

This method performs a Lightweight Directory Access Protocol (LDAP) modify RDN operation on an entry specified by DN .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ModifyRDN(const char* lpszNewRDN);

Unicode (Windows)
INT ModifyRDN(LPCWSTR lpszNewRDN);

int ipworksauth_ldap_modifyrdn(void* lpObj, const char* lpszNewRDN);

int ModifyRDN(const QString& qsNewRDN);

Remarks

This method performs an LDAP modify RDN operation on the entry specified by DN.

NewRDN is the new RDN for the entry specified by DN

The result of the operation is returned through the Result event.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

MoveToDN Method (LDAP Class)

This method performs a Lightweight Directory Access Protocol (LDAP) modify operation on the entry specified by DN by changing its superior.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int MoveToDN(const char* lpszNewSuperior);

Unicode (Windows)
INT MoveToDN(LPCWSTR lpszNewSuperior);

int ipworksauth_ldap_movetodn(void* lpObj, const char* lpszNewSuperior);

int MoveToDN(const QString& qsNewSuperior);

Remarks

This method performs an LDAP modify operation on the entry specified by DN by changing its superior.

Note: None of the entry's attributes will change. DeleteOldRDN property will be set to True to delete the old entry. The result of the operation is returned through the Result event.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

PauseData Method (LDAP Class)

This method pauses data reception.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int PauseData();

Unicode (Windows)
INT PauseData();

int ipworksauth_ldap_pausedata(void* lpObj);

int PauseData();

Remarks

This method pauses data reception when called. While data reception is paused, incoming data will not be processed and events will not fire. Call ProcessData to reenable data reception.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ProcessData Method (LDAP Class)

This method reenables data reception after a call to PauseData .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ProcessData();

Unicode (Windows)
INT ProcessData();

int ipworksauth_ldap_processdata(void* lpObj);

int ProcessData();

Remarks

This method reenables data reception after a previous call to PauseData. Call this method to reenable data reception and allow IPPacket to fire.

Note: This method is used only after previously calling PauseData. It does not need to be called to process data by default.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (LDAP Class)

Reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksauth_ldap_reset(void* lpObj);

int Reset();

Remarks

This method will reset the class's properties to their default values.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Search Method (LDAP Class)

This method searches the directory server using the base object specified in DN and the search filter SearchFilter .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Search(const char* lpszSearchFilter);

Unicode (Windows)
INT Search(LPCWSTR lpszSearchFilter);

int ipworksauth_ldap_search(void* lpObj, const char* lpszSearchFilter);

int Search(const QString& qsSearchFilter);

Remarks

This method searches the directory server using the base object specified in the DN and the search filter specified in the SearchFilter parameter. Additional search parameters are specified through the SearchScope, SearchDerefAliases, SearchSizeLimit, SearchTimeLimit, and SearchReturnValues properties.

If Attributes are specified before starting a search, the server will return only those results that contain a value for the specified attributes.

Results are returned through zero or more SearchResult events, after which a SearchComplete event is fired.

Example 1. Searching for a User:

LDAPControl.DN = "ou=Employees,dc=server" LDAPControl.Search("uid=TThompson")

A Directory-Specific Entries (DSE) search will search for the attributes of the server. Example 2. DSE Search:

LDAPControl.DN = "" LDAPControl.SearchScope = 0 LDAPControl.Search("objectClass=*")

SearchFilter is a string representation of the Lightweight Directory Access Protocol (LDAP) search filter used for the search.

The format of the search filter is specified by RFC 1558 and is identical to the format used by most LDAP applications.

The following are examples of search filters, as provided in the RFC:

Example 3. Search Filters:

     (cn=Babs Jensen)
     (!(cn=Tim Howes))
     (&(objectClass=Person)(|(sn=Jensen)(cn=Babs J*)))
     (o=univ*of*mich*)

The complete specification is given by the following BNF:

     <filter> ::= "(" <filtercomp> ")"
     <filtercomp> ::= <and> | <or> | <not> | <item>
     <and> ::= "&" <filterlist>
     <or> ::= "|" <filterlist>
     <not> ::= "!" <filter>
     <filterlist> ::= <filter> | <filter> <filterlist>
     <item> ::= <simple> | <present> | <substring>
     <simple> ::= <attr> <filtertype> <value>
     <filtertype> ::= <equal> | <approx> | <greater> | <less>
     <equal> ::= "="
     <approx> ::= "~="
     <greater> ::= ">="
     <less> ::= "<="
     <present> ::= <attr> "=*"
     <substring> ::= <attr> "=" <initial> <any> <final>
     <initial> ::= NULL | <value>
     <any> ::= "*" <starval>
     <starval> ::= NULL | <value> "*" <starval>
     <final> ::= NULL | <value>

<attr> is a string representing an attribute type as defined in RFC 1777. <value> is a string representing an attribute value, or part of one, and has the form defined in RFC 1779. If a <value> must contain one of the characters '*' or '(' or ')', these should be escaped by preceding them with the backslash '\' character.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Unbind Method (LDAP Class)

This method unbinds from the directory server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Unbind();

Unicode (Windows)
INT Unbind();

int ipworksauth_ldap_unbind(void* lpObj);

int Unbind();

Remarks

This method unbinds from the directory server and breaks the connection.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ComputerList Event (LDAP Class)

This event is fired for each computer entry returned.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireComputerList(LDAPComputerListEventParams *e);

typedef struct {
  const char *name;
  const char *operatingSystem;
  const char *lastLogon;
  int logonCount;
  const char *dn;
  int reserved;
} LDAPComputerListEventParams;


Unicode (Windows)
virtual INT FireComputerList(LDAPComputerListEventParams *e);

typedef struct {
  LPCWSTR name;
  LPCWSTR operatingSystem;
  LPCWSTR lastLogon;
  INT logonCount;
  LPCWSTR dn;
  INT reserved;
} LDAPComputerListEventParams;

#define EID_LDAP_COMPUTERLIST 1

virtual INT IPWORKSAUTH_CALL FireComputerList(LPSTR &lpszname, LPSTR &lpszoperatingSystem, LPSTR &lpszlastLogon, INT &ilogonCount, LPSTR &lpszdn);

class LDAPComputerListEventParams {
public:
  const QString &name();

  const QString &operatingSystem();

  const QString &lastLogon();

  int logonCount();

  const QString &dn();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ComputerList(LDAPComputerListEventParams *e);

// Or, subclass LDAP and override this emitter function.
virtual int FireComputerList(LDAPComputerListEventParams *e) {...}

Remarks

This event is fired once for each computer returned when the ListComputers method is called.

Connected Event (LDAP Class)

This event is fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnected(LDAPConnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} LDAPConnectedEventParams;


Unicode (Windows)
virtual INT FireConnected(LDAPConnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} LDAPConnectedEventParams;

#define EID_LDAP_CONNECTED 2

virtual INT IPWORKSAUTH_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);

class LDAPConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Connected(LDAPConnectedEventParams *e);

// Or, subclass LDAP and override this emitter function.
virtual int FireConnected(LDAPConnectedEventParams *e) {...}

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (LDAP Class)

This event is fired to indicate changes in the connection state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionStatus(LDAPConnectionStatusEventParams *e);

typedef struct {
  const char *ConnectionEvent;
  int StatusCode;
  const char *Description;
  int reserved;
} LDAPConnectionStatusEventParams;


Unicode (Windows)
virtual INT FireConnectionStatus(LDAPConnectionStatusEventParams *e);

typedef struct {
  LPCWSTR ConnectionEvent;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} LDAPConnectionStatusEventParams;

#define EID_LDAP_CONNECTIONSTATUS 3

virtual INT IPWORKSAUTH_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);

class LDAPConnectionStatusEventParams {
public:
  const QString &ConnectionEvent();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ConnectionStatus(LDAPConnectionStatusEventParams *e);

// Or, subclass LDAP and override this emitter function.
virtual int FireConnectionStatus(LDAPConnectionStatusEventParams *e) {...}

Remarks

The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

Disconnected Event (LDAP Class)

This event is fired when a connection is closed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDisconnected(LDAPDisconnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} LDAPDisconnectedEventParams;


Unicode (Windows)
virtual INT FireDisconnected(LDAPDisconnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} LDAPDisconnectedEventParams;

#define EID_LDAP_DISCONNECTED 4

virtual INT IPWORKSAUTH_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);

class LDAPDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnected(LDAPDisconnectedEventParams *e);

// Or, subclass LDAP and override this emitter function.
virtual int FireDisconnected(LDAPDisconnectedEventParams *e) {...}

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

Error Event (LDAP Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(LDAPErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} LDAPErrorEventParams;


Unicode (Windows)
virtual INT FireError(LDAPErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} LDAPErrorEventParams;

#define EID_LDAP_ERROR 5

virtual INT IPWORKSAUTH_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class LDAPErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(LDAPErrorEventParams *e);

// Or, subclass LDAP and override this emitter function.
virtual int FireError(LDAPErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

ExtendedResponse Event (LDAP Class)

This event is fired for Lightweight Directory Access Protocol (LDAP) V3 extended responses.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireExtendedResponse(LDAPExtendedResponseEventParams *e);

typedef struct {
  int MessageId;
  const char *DN;
  int ResultCode;
  const char *ResultDescription;
  const char *ResponseName;
  const char *ResponseValue;
  int lenResponseValue;
  int reserved;
} LDAPExtendedResponseEventParams;


Unicode (Windows)
virtual INT FireExtendedResponse(LDAPExtendedResponseEventParams *e);

typedef struct {
  INT MessageId;
  LPCWSTR DN;
  INT ResultCode;
  LPCWSTR ResultDescription;
  LPCWSTR ResponseName;
  LPCSTR ResponseValue;
  INT lenResponseValue;
  INT reserved;
} LDAPExtendedResponseEventParams;

#define EID_LDAP_EXTENDEDRESPONSE 6

virtual INT IPWORKSAUTH_CALL FireExtendedResponse(INT &iMessageId, LPSTR &lpszDN, INT &iResultCode, LPSTR &lpszResultDescription, LPSTR &lpszResponseName, LPSTR &lpResponseValue, INT &lenResponseValue);

class LDAPExtendedResponseEventParams {
public:
  int MessageId();

  const QString &DN();

  int ResultCode();

  const QString &ResultDescription();

  const QString &ResponseName();

  const QByteArray &ResponseValue();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ExtendedResponse(LDAPExtendedResponseEventParams *e);

// Or, subclass LDAP and override this emitter function.
virtual int FireExtendedResponse(LDAPExtendedResponseEventParams *e) {...}

Remarks

The first four parameters are the same as the parameters of the Result event. ResponseName and ResponseValue are related to the corresponding parameters of the call to ExtendedRequest.

GroupList Event (LDAP Class)

This event is fired for each group entry returned.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireGroupList(LDAPGroupListEventParams *e);

typedef struct {
  const char *name;
  const char *description;
  const char *dn;
  int reserved;
} LDAPGroupListEventParams;


Unicode (Windows)
virtual INT FireGroupList(LDAPGroupListEventParams *e);

typedef struct {
  LPCWSTR name;
  LPCWSTR description;
  LPCWSTR dn;
  INT reserved;
} LDAPGroupListEventParams;

#define EID_LDAP_GROUPLIST 7

virtual INT IPWORKSAUTH_CALL FireGroupList(LPSTR &lpszname, LPSTR &lpszdescription, LPSTR &lpszdn);

class LDAPGroupListEventParams {
public:
  const QString &name();

  const QString &description();

  const QString &dn();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void GroupList(LDAPGroupListEventParams *e);

// Or, subclass LDAP and override this emitter function.
virtual int FireGroupList(LDAPGroupListEventParams *e) {...}

Remarks

This event is fired once for each group entry returned when either of the ListGroups or ListUserGroups methods are called.

PITrail Event (LDAP Class)

This event provides detailed information about the interaction with the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePITrail(LDAPPITrailEventParams *e);

typedef struct {
  int Direction;
  const char *Description;
  const char *Message;
  int reserved;
} LDAPPITrailEventParams;


Unicode (Windows)
virtual INT FirePITrail(LDAPPITrailEventParams *e);

typedef struct {
  INT Direction;
  LPCWSTR Description;
  LPCWSTR Message;
  INT reserved;
} LDAPPITrailEventParams;

#define EID_LDAP_PITRAIL 8

virtual INT IPWORKSAUTH_CALL FirePITrail(INT &iDirection, LPSTR &lpszDescription, LPSTR &lpszMessage);

class LDAPPITrailEventParams {
public:
  int Direction();

  const QString &Description();

  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void PITrail(LDAPPITrailEventParams *e);

// Or, subclass LDAP and override this emitter function.
virtual int FirePITrail(LDAPPITrailEventParams *e) {...}

Remarks

The PITrail event provides detailed information about all communication with the server. This is useful for debugging purposes.

Direction specifies the origin of the data. Possible values are as follows:

• 0 - Client
• 1 - Server

Description is a short description of the current packet. This is human readable and useful for informational logging.

Message contains a hex-encoded version of the raw message. This represents the exact value sent over the wire.

Result Event (LDAP Class)

This event is fired for every server response, except for search responses.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireResult(LDAPResultEventParams *e);

typedef struct {
  int MessageId;
  const char *DN;
  int ResultCode;
  const char *ResultDescription;
  int reserved;
} LDAPResultEventParams;


Unicode (Windows)
virtual INT FireResult(LDAPResultEventParams *e);

typedef struct {
  INT MessageId;
  LPCWSTR DN;
  INT ResultCode;
  LPCWSTR ResultDescription;
  INT reserved;
} LDAPResultEventParams;

#define EID_LDAP_RESULT 9

virtual INT IPWORKSAUTH_CALL FireResult(INT &iMessageId, LPSTR &lpszDN, INT &iResultCode, LPSTR &lpszResultDescription);

class LDAPResultEventParams {
public:
  int MessageId();

  const QString &DN();

  int ResultCode();

  const QString &ResultDescription();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Result(LDAPResultEventParams *e);

// Or, subclass LDAP and override this emitter function.
virtual int FireResult(LDAPResultEventParams *e) {...}

Remarks

The MessageId parameter identifies the corresponding request. ResultCode and ResultDescription show whether or not the operation was successful (on a successful operation, the ResultCode is 0). For a full list of possible result codes, see the ResultCode property.

SearchComplete Event (LDAP Class)

This event is fired upon completion of a search operation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSearchComplete(LDAPSearchCompleteEventParams *e);

typedef struct {
  int MessageId;
  const char *DN;
  int ResultCode;
  const char *ResultDescription;
  int reserved;
} LDAPSearchCompleteEventParams;


Unicode (Windows)
virtual INT FireSearchComplete(LDAPSearchCompleteEventParams *e);

typedef struct {
  INT MessageId;
  LPCWSTR DN;
  INT ResultCode;
  LPCWSTR ResultDescription;
  INT reserved;
} LDAPSearchCompleteEventParams;

#define EID_LDAP_SEARCHCOMPLETE 10

virtual INT IPWORKSAUTH_CALL FireSearchComplete(INT &iMessageId, LPSTR &lpszDN, INT &iResultCode, LPSTR &lpszResultDescription);

class LDAPSearchCompleteEventParams {
public:
  int MessageId();

  const QString &DN();

  int ResultCode();

  const QString &ResultDescription();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SearchComplete(LDAPSearchCompleteEventParams *e);

// Or, subclass LDAP and override this emitter function.
virtual int FireSearchComplete(LDAPSearchCompleteEventParams *e) {...}

Remarks

The MessageId parameter identifies the corresponding request. ResultCode and ResultDescription show whether the operation was successful (on a successful operation, the ResultCode is 0).

SearchPage Event (LDAP Class)

This event is fired for every page returned from a search operation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSearchPage(LDAPSearchPageEventParams *e);

typedef struct {
  int MessageId;
  const char *DN;
  int ResultCode;
  const char *ResultDescription;
  int CancelSearch;
  int reserved;
} LDAPSearchPageEventParams;


Unicode (Windows)
virtual INT FireSearchPage(LDAPSearchPageEventParams *e);

typedef struct {
  INT MessageId;
  LPCWSTR DN;
  INT ResultCode;
  LPCWSTR ResultDescription;
  BOOL CancelSearch;
  INT reserved;
} LDAPSearchPageEventParams;

#define EID_LDAP_SEARCHPAGE 11

virtual INT IPWORKSAUTH_CALL FireSearchPage(INT &iMessageId, LPSTR &lpszDN, INT &iResultCode, LPSTR &lpszResultDescription, BOOL &bCancelSearch);

class LDAPSearchPageEventParams {
public:
  int MessageId();

  const QString &DN();

  int ResultCode();

  const QString &ResultDescription();

  bool CancelSearch();
  void SetCancelSearch(bool bCancelSearch);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SearchPage(LDAPSearchPageEventParams *e);

// Or, subclass LDAP and override this emitter function.
virtual int FireSearchPage(LDAPSearchPageEventParams *e) {...}

Remarks

This event is fired so the client can decide whether or not to continue with the Search operation. The signature is very similar to the SearchComplete event, with the addition of a CancelSearch parameter. If the search should be canceled (no more pages), the CancelSearch parameter should be set to True.

SearchResult Event (LDAP Class)

This event is fired for every entry returned from a search operation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSearchResult(LDAPSearchResultEventParams *e);

typedef struct {
  int MessageId;
  const char *DN;
  int reserved;
} LDAPSearchResultEventParams;


Unicode (Windows)
virtual INT FireSearchResult(LDAPSearchResultEventParams *e);

typedef struct {
  INT MessageId;
  LPCWSTR DN;
  INT reserved;
} LDAPSearchResultEventParams;

#define EID_LDAP_SEARCHRESULT 12

virtual INT IPWORKSAUTH_CALL FireSearchResult(INT &iMessageId, LPSTR &lpszDN);

class LDAPSearchResultEventParams {
public:
  int MessageId();

  const QString &DN();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SearchResult(LDAPSearchResultEventParams *e);

// Or, subclass LDAP and override this emitter function.
virtual int FireSearchResult(LDAPSearchResultEventParams *e) {...}

Remarks

MessageId identifies the corresponding search request. DN contains the distinguished name of the entry. The attribute type and value provided in the Attributes properties show the list of retrieved attributes for the entry.

Every search operation results in a sequence of 0 or more SearchResult events and a sequence of 0 or more SearchResultReference events, which are followed by a SearchComplete event.

SearchResultReference Event (LDAP Class)

This event is fired for every result reference returned from a search operation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSearchResultReference(LDAPSearchResultReferenceEventParams *e);

typedef struct {
  int MessageId;
  const char *LdapUrl;
  int reserved;
} LDAPSearchResultReferenceEventParams;


Unicode (Windows)
virtual INT FireSearchResultReference(LDAPSearchResultReferenceEventParams *e);

typedef struct {
  INT MessageId;
  LPCWSTR LdapUrl;
  INT reserved;
} LDAPSearchResultReferenceEventParams;

#define EID_LDAP_SEARCHRESULTREFERENCE 13

virtual INT IPWORKSAUTH_CALL FireSearchResultReference(INT &iMessageId, LPSTR &lpszLdapUrl);

class LDAPSearchResultReferenceEventParams {
public:
  int MessageId();

  const QString &LdapUrl();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SearchResultReference(LDAPSearchResultReferenceEventParams *e);

// Or, subclass LDAP and override this emitter function.
virtual int FireSearchResultReference(LDAPSearchResultReferenceEventParams *e) {...}

Remarks

MessageId identifies the corresponding search request. LdapUrl contains a URL reference to a server that can be used for continuing the search operation.

Every search operation results in a sequence of 0 or more SearchResult events and a sequence of 0 or more SearchResultReference events, which are followed by a SearchComplete event.

SSLServerAuthentication Event (LDAP Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(LDAPSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} LDAPSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(LDAPSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} LDAPSSLServerAuthenticationEventParams;

#define EID_LDAP_SSLSERVERAUTHENTICATION 14

virtual INT IPWORKSAUTH_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class LDAPSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(LDAPSSLServerAuthenticationEventParams *e);

// Or, subclass LDAP and override this emitter function.
virtual int FireSSLServerAuthentication(LDAPSSLServerAuthenticationEventParams *e) {...}

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (LDAP Class)

Shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(LDAPSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} LDAPSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(LDAPSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} LDAPSSLStatusEventParams;

#define EID_LDAP_SSLSTATUS 15

virtual INT IPWORKSAUTH_CALL FireSSLStatus(LPSTR &lpszMessage);

class LDAPSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(LDAPSSLStatusEventParams *e);

// Or, subclass LDAP and override this emitter function.
virtual int FireSSLStatus(LDAPSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

UserList Event (LDAP Class)

This event is fired once for each user entry returned.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireUserList(LDAPUserListEventParams *e);

typedef struct {
  const char *name;
  const char *description;
  const char *lastLogon;
  const char *memberOf;
  const char *dn;
  int reserved;
} LDAPUserListEventParams;


Unicode (Windows)
virtual INT FireUserList(LDAPUserListEventParams *e);

typedef struct {
  LPCWSTR name;
  LPCWSTR description;
  LPCWSTR lastLogon;
  LPCWSTR memberOf;
  LPCWSTR dn;
  INT reserved;
} LDAPUserListEventParams;

#define EID_LDAP_USERLIST 16

virtual INT IPWORKSAUTH_CALL FireUserList(LPSTR &lpszname, LPSTR &lpszdescription, LPSTR &lpszlastLogon, LPSTR &lpszmemberOf, LPSTR &lpszdn);

class LDAPUserListEventParams {
public:
  const QString &name();

  const QString &description();

  const QString &lastLogon();

  const QString &memberOf();

  const QString &dn();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void UserList(LDAPUserListEventParams *e);

// Or, subclass LDAP and override this emitter function.
virtual int FireUserList(LDAPUserListEventParams *e) {...}

Remarks

This event is fired once for each user entry returned when the ListGroupMembers method is called.

Config Settings (LDAP Class)

LDAP Config Settings

TCPClient Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (LDAP Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

LDAP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

TCP/IP Errors