ADSSession class

Connect method

The Connect method authenticates the client and establishes a session with the Arcana Scheduler service.

Syntax

 

C++

hr=session->Connect(BSTR password)

VB

session.Connect(BSTR password)

Parameters and Return Value

 

password

An optional password. The password may or may not be required, depending on the security setup for the Scheduler service to which you are attempting to connect. Look for "security" in the Arcana Scheduler help index for more information on authentication.

Error Codes

The following error codes are commonly encountered with this method. See the Error Codes topic for additional error-handling information.

 

ADS_PASSWORD_REQUIRED

A password is required to connect to the Scheduler service.

ADS_E_SERVICE_NOT_RUNNING

The Arcana Scheduler service is not running. Use the StartService method to start it, then retry the connection.

ADS_E_VERSION_MISMATCH

The version of the Arcana Scheduler running on the server is different from the version being used by the client.

ADS_E_INVALID_PASSWORD

The specified password is invalid.

Remarks

To connect to the Scheduler on a remote computer you may use either of the following options: