ActiveDirectory Class

Properties   Methods   Events   Config Settings   Errors  

The ActiveDirectory class can be used to authenticate users against Active Directory using Kerberos 5.0.

Syntax

ActiveDirectory

Remarks

The ActiveDirectory class authenticates users against Active Directory. Authentication is performed using the Kerberos protocol defined in RFC 1510 and RFC 4120.

Authentication

When Authenticate is called the class will attempt to authenticate the user with the Active Directory server. The class will communicate with the ADHost to obtain a service ticket and populate AuthToken. The following properties are required when calling this method:

• SPN (required)
• User (required)
• Password (required)
• ADHost (required)

A typical sequence of messages would be:

• KRB_AS_REQ -> KDC
• KRB_AS_REP <- KDC
• KRB_TGS_REQ -> KDC
• KRB_TGS_REP <- KDC
• AuthToken is populated with the constructed KRB_AP_REP message.

Communication with the ADHost can be seen through the PITrail event.

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.

ADHost Property (ActiveDirectory Class)

The domain name or IP address of the Active Directory server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetADHost();
int SetADHost(const char* lpszADHost);

Unicode (Windows)
LPWSTR GetADHost();
INT SetADHost(LPCWSTR lpszADHost);

char* ipworksauth_activedirectory_getadhost(void* lpObj);
int ipworksauth_activedirectory_setadhost(void* lpObj, const char* lpszADHost);

QString GetADHost();
int SetADHost(QString qsADHost);

Default Value

""

Remarks

This property specifies the IP address (IP number in dotted internet format) or Domain Name of the Active Directory server.

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

ADPort Property (ActiveDirectory Class)

The port for the Active Directory server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetADPort();
int SetADPort(int iADPort);

Unicode (Windows)
INT GetADPort();
INT SetADPort(INT iADPort);

int ipworksauth_activedirectory_getadport(void* lpObj);
int ipworksauth_activedirectory_setadport(void* lpObj, int iADPort);

int GetADPort();
int SetADPort(int iADPort);

Default Value

88

Remarks

This property specifies the port for the Active Directory server. The default value is 88.

Data Type

Integer

AuthMechanism Property (ActiveDirectory Class)

The authentication mechanism to be used when connecting to the Active Directory server.

Syntax

• C++
• C
• Qt

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

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

AAM_SIMPLE(0), 
AAM_DIGEST_MD5(1), 
AAM_NEGOTIATE(2), 
AAM_KERBEROS(6)

int ipworksauth_activedirectory_getauthmechanism(void* lpObj);
int ipworksauth_activedirectory_setauthmechanism(void* lpObj, int iAuthMechanism);

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

Default Value

6

Remarks

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

Data Type

Integer

AuthToken Property (ActiveDirectory Class)

The authentication token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthToken(char* &lpAuthToken, int &lenAuthToken);

Unicode (Windows)
INT GetAuthToken(LPSTR &lpAuthToken, INT &lenAuthToken);

int ipworksauth_activedirectory_getauthtoken(void* lpObj, char** lpAuthToken, int* lenAuthToken);

QByteArray GetAuthToken();

Default Value

""

Remarks

This property holds the authentication token.

This property will be populated after calling Authenticate. This may be used in by another entity to authenticate to the service. For instance this may be used in HTTP to authenticate to a web service.

The content of this property is a KRB_AP_REQ message. This is sometimes referred to as an "Authentication Header". It is comprised of the service ticket that was obtained from the TGS and an encrypted authenticator.

This property is read-only.

Data Type

Binary String

Password Property (ActiveDirectory Class)

The user's password.

Syntax

• C++
• C
• Qt

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

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

char* ipworksauth_activedirectory_getpassword(void* lpObj);
int ipworksauth_activedirectory_setpassword(void* lpObj, const char* lpszPassword);

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

Default Value

""

Remarks

This property specifies the user's password. This must be set before calling Authenticate.

Data Type

String

SPN Property (ActiveDirectory Class)

The Service Principal Name (SPN).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSPN();
int SetSPN(const char* lpszSPN);

Unicode (Windows)
LPWSTR GetSPN();
INT SetSPN(LPCWSTR lpszSPN);

char* ipworksauth_activedirectory_getspn(void* lpObj);
int ipworksauth_activedirectory_setspn(void* lpObj, const char* lpszSPN);

QString GetSPN();
int SetSPN(QString qsSPN);

Default Value

""

Remarks

This property specifies the Service Principal Name (SPN). This must be set before calling Authenticate.

Data Type

String

Timeout Property (ActiveDirectory 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_activedirectory_gettimeout(void* lpObj);
int ipworksauth_activedirectory_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 will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

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

User Property (ActiveDirectory Class)

The name and domain of the user to authenticate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUser();
int SetUser(const char* lpszUser);

Unicode (Windows)
LPWSTR GetUser();
INT SetUser(LPCWSTR lpszUser);

char* ipworksauth_activedirectory_getuser(void* lpObj);
int ipworksauth_activedirectory_setuser(void* lpObj, const char* lpszUser);

QString GetUser();
int SetUser(QString qsUser);

Default Value

""

Remarks

This property specifies the name and realm/domain of the user. The value specified must be in one of the following formats:

• user@domain
• domain/user

Data Type

String

Authenticate Method (ActiveDirectory Class)

Authenticates the user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Authenticate();

Unicode (Windows)
INT Authenticate();

int ipworksauth_activedirectory_authenticate(void* lpObj);

int Authenticate();

Remarks

This method authenticates the User.

Authentication

When Authenticate is called the class will attempt to authenticate the user with the Active Directory server. The class will communicate with the ADHost to obtain a service ticket and populate AuthToken. The following properties are required when calling this method:

• SPN (required)
• User (required)
• Password (required)
• ADHost (required)

A typical sequence of messages would be:

• KRB_AS_REQ -> KDC
• KRB_AS_REP <- KDC
• KRB_TGS_REQ -> KDC
• KRB_TGS_REP <- KDC
• AuthToken is populated with the constructed KRB_AP_REP message.

Communication with the ADHost can be seen through the PITrail 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.)

ChangePassword Method (ActiveDirectory Class)

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_activedirectory_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 paswsword and NewPassword specifies the new password.

Note: This operation can only be performed over the SSL Port. Set ADPort 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.)

Config Method (ActiveDirectory 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_activedirectory_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.

DoEvents Method (ActiveDirectory Class)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworksauth_activedirectory_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.)

Interrupt Method (ActiveDirectory Class)

Interrupt the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworksauth_activedirectory_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 (ActiveDirectory Class)

Lists all computers in the directory.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListComputers();

Unicode (Windows)
INT ListComputers();

int ipworksauth_activedirectory_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 (ActiveDirectory Class)

List 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_activedirectory_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 (ActiveDirectory Class)

List all groups in the directory.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListGroups();

Unicode (Windows)
INT ListGroups();

int ipworksauth_activedirectory_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 (ActiveDirectory Class)

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_activedirectory_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.)

Reset Method (ActiveDirectory Class)

Resets the class properties to their default values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksauth_activedirectory_reset(void* lpObj);

int Reset();

Remarks

This method resets the 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.)

ComputerList Event (ActiveDirectory Class)

Fired for each computer entry returned.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_ACTIVEDIRECTORY_COMPUTERLIST 1

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

class ActiveDirectoryComputerListEventParams {
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(ActiveDirectoryComputerListEventParams *e);

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

Remarks

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

Error Event (ActiveDirectory Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_ACTIVEDIRECTORY_ERROR 2

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

class ActiveDirectoryErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass ActiveDirectory and override this emitter function.
virtual int FireError(ActiveDirectoryErrorEventParams *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.

GroupList Event (ActiveDirectory Class)

Fired for each group entry returned.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_ACTIVEDIRECTORY_GROUPLIST 3

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

class ActiveDirectoryGroupListEventParams {
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(ActiveDirectoryGroupListEventParams *e);

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

Remarks

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

Log Event (ActiveDirectory Class)

Fires once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(ActiveDirectoryLogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} ActiveDirectoryLogEventParams;


Unicode (Windows)
virtual INT FireLog(ActiveDirectoryLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} ActiveDirectoryLogEventParams;

#define EID_ACTIVEDIRECTORY_LOG 4

virtual INT IPWORKSAUTH_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class ActiveDirectoryLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

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

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

// Or, subclass ActiveDirectory and override this emitter function.
virtual int FireLog(ActiveDirectoryLogEventParams *e) {...}

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of the Message. Possible values are:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

LogType identifies the type of log entry. Possible values are:

• Info
• Verbose
• Debug

PITrail Event (ActiveDirectory Class)

Traces the messages sent to the server, and the respective replies.

Syntax

• C++
• C
• Qt

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

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


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

typedef struct {
  INT Direction;
  LPCWSTR Message;
  INT reserved;
} ActiveDirectoryPITrailEventParams;

#define EID_ACTIVEDIRECTORY_PITRAIL 5

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

class ActiveDirectoryPITrailEventParams {
public:
  int Direction();

  const QString &Message();

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

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

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

Remarks

The PITrail event is useful for debugging purposes. It shows all the interaction between the client and the server. To include the raw packets set LogKerberosPackets to True.

The Message parameter contains the full text of the message. The Direction parameter shows the originator of the message:

UserList Event (ActiveDirectory Class)

Fired once for each user entry returned.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_ACTIVEDIRECTORY_USERLIST 6

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

class ActiveDirectoryUserListEventParams {
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(ActiveDirectoryUserListEventParams *e);

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

Remarks

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

Config Settings (ActiveDirectory Class)

ActiveDirectory Config Settings

TCPClient Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (ActiveDirectory 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.

AD Errors

UDP Errors

TCP/IP Errors