RDTA.PickDP.Extensions.connection Control

Defines the connection to the database server.

Public Constructors

New

Constructor.

Public Methods

close

Closes the connection with the database.

getDatabase

Gets the connDatabase Object controlling this connection.

getTableNames

Returns the names of the available tables in the database as an array of stings.

isConnected

Gets the connection status.

MemberwiseClone

Returns a copy of the current instance. For internal use only.

open

Opens a connection to the database server.

setDatabase

Sets the new connDatabase Object.

Public Properties

Name

Type

Description

AccountPassword

String

Sets the D3 account password.

Database

String

Sets the connection's account.

Debug

Boolean

Enables debugging.

Host

String

Sets the connection's host name or IP address.

Password

String

Sets the password.

Port

Integer

Sets the connection's TCP socket port.

Status

Integer

Returns the current status of the connection. See the constants in the connDatabase class for a description of the connection status values.

StatusMessage

String

Returns the status message for the specified status code.

StatusMessage

String

Returns the current status message of the connection.

User

String

Sets the connection's user name.

Public Events

Name

Type

Description

OnConnected

Event

Event thrown when the connection is opened.

OnDisConnected

Event

Event thrown when the connection is closed.

Error Messages

The table below list the error codes returned by the PickDP account when trying to establish a connection.

 

Name

Value

Value returned and Description

kDatabase_DemoLicenseExpired

97

Error returned when the demo (temporary) license activation expires.

kDatabase_IllegalAccount

80

Error returned when attempting to open an account that is not exposed, does not exist, or is password protected.

kDatabase_IllegalPassword

87

Error returned on invalid user passwords.

kDatabase_IllegalUser

86

Error returned on invalid user names.

kDatabase_LogtoFailed

81

Error returned when attempting to log on to an account that does not exist or is password protected.

kDatabase_NoAvailableLicenses

98

Error returned when no Pick Data Provider licenses are available to service the call.

kDatabase_NoConnectionsFile

84

Error returned when the temporary file containing the current connection's information does not exist.

kDatabase_NoHost

89

Error returned when the host server could not be reached.

kDatabase_NoLogConnectionsFile

85

Error returned when the connection log file does not exist.

kDatabase_NoMasterDictionary

82

  • For D3: Error returned when the request could not open the md file.

  • For U2: Error returned when the request could not open the VOC file.

kDatabase_NoMasterTable

83

Error returned when the database's master table is not found or is corrupted.

kDatabase_NoUsersFile

88

Error returned when the Pick Data Provider users file defined in MASTER does not exist.

kDatabase_SocketError

90

Error returned when a socket error occurs.

kDatabase_Success

0

No error.

kDatabase_WrongLicense

99

Error returned on invalid license information.

kDatabase_WrongVersion

91

Error returned on invalid license information.

 

5