<< Click to Display Table of Contents >>
Properties |
The available properties in the E3DataAccess Library are described next.
ActiveServer
This is a read-only property and returns the name of the current active server.
AutoConnect
This property configures whether a user does not explicitly controls connection and disconnection (True) or a user explicitly controls connection and disconnection (False).
ConnectionState
This is a read-only property and returns the status of a connection. Possible values for this property are 0: Disconnected, 1: Connecting, 2: Connected, or 3: Disconnecting.
ConnectionTimeoutMs
This property indicates the maximum time to connect to a server.
DomainState
This is a read-only property and returns the status of a Domain. Possible values for this property are 0: Unknown, 1: In Hot-Standby, 2: Stopped, or 3: Executing.
HeartBeatCheckMs
This property indicates an interval, in milliseconds, between heartbeat messages to the server. This value must be greater than the value in the HeartBeatMs property, typically double the time.
HeartBeatMs
This property indicates the maximum time, in milliseconds, to send a heartbeat message to the server. Configuring this property as 0 (zero) disables sending a heartbeat message (not recommended).
IsReadOnly
This is a read-only property and indicates whether the connection to a Domain is read-only.
PingTimeoutMs
This property indicates the maximum waiting time for a ping command. Configuring this property as 0 (zero) disables the ping command.
This property indicates the name of the E3 or Elipse Power server or servers to connect. For more than one server, separate values using commas.
StartReadOnly
This property configures whether the connection with the server starts in read-only mode or not.
User
This is a read-only property and indicates the name of the user currently logged in the E3 or Elipse Power server.