VRDistributedConnection
Properties
Exported Properties
The Distributed Connection Object exports the following properties:
- AutoConnect
- Connected
- ConnectionName
- ConnHandle
- ConnRetries
- Listen
- ProcessType
AutoConnect
This property can only be set from the design environment. If set to 1 (TRUE), the object will connect to the server process when it is created, i.e. when the client process starts.
Note: This property is read-only and cannot be set with VRSet.
- Applies to
- Clients
- Data Type
- Boolean
- Possible Values
- 1 (true)
- 0 (false)
Connected
This is a boolean property that indicates the connection status for a client object. if the object is connected to a server, the property is set to 1 (TRUE).
Note: This property is read-only and cannot be set with VRSet.
- Applies to
- Clients
- Data Type
- Boolean
- Possible Values
- 1 (true)
- 0 (false)
ConnectionName
This property MUST be set. It contains the sybolic connection name and must be same for the Client, the Server and in the Connection Profile.
Note: The Sybolic Name Must be unique for each connection profile and no longer than 8 characters long (A-Z and 0-9).
Warning: if you set the AutoConnect property to 1 you MUST set the ConnectionName at design time.
- Applies to
- Servers
- Clients
- Data Type
- String
- Possible Values
- String of up to 8 characters (A-Z and 0-9)
ConnHandle
This is a numeric property that contains the unique connection handle for the client. It is only valid after connecting to a server.
Note: This property is read-only and cannot be set with VRSet.
- Applies to
- Clients
- Data Type
- Numeric
- Possible Values
- Any whole number
ConnRetries
When connecting through the NetBIOS protocol to a server that has not started, the delay to start the server process can be quite long, especially with a VX-REXX application, and exceed the Wait for Open setting in the Connection Profile. This property tells the client object how many times to retry before returning an error; The default value is 2.
- Applies to
- Clients
- Data Type
- Numeric
- Possible Values
- Any whole number
Listen
This property is set at design time and cannot be changed. If the property is set, a thread is started that will listen for messages from the server. Use this property if you want to have the server send asynchronous messages to its clients.
Note: This property is read-only and cannot be set with VRSet.
- Applies to
- Clients
- Data Type
- Boolean
- Possible Values
- 1 (true)
- 0 (false)
ProcessType
This property is set at design time and cannot be changed. It defines the behavior of the Distributed Connection Object as either a Client or a Server.
Note: This property is read-only and cannot be set with VRSet.
- Applies to
- Clients
- Data Type
- String
- Possible Values
- Server
- Client
Inherited Properties
Inherits the following properties from the VX-REXX Descriptive Text Object:
- Caption
- ClassName
- ClipSiblings
- Enabled
- FirstChild
- Font
- ForeColor
- Height
- HelpTag
- HelpText
- HintText
- HWnd
- Left
- Name
- Painting
- Parent
- Query
- QueryColumns
- Self
- Sibling
- SiblingOrder
- Top
- UserData
- Visible
- Width