CxCvsEditor Methods
The CxCvsEditor object contains the following methods:
Connect
The Connect method connects the object to a service.
Syntax
Connect(SiteService As String)
Parameters
| Parameter | Required | Description |
|---|---|---|
|
SiteService |
Yes |
The Site.Service to which to connect. The domain is optional. The service must be a valid one. |
Remarks
Returns 0 if successful and a non-zero value if the connection failed.
Example
The following example connects the Client object to the CYGDEMO.<SVC> on domain 5410:
Sub
Dim CvsEditor
Set CvsEditor = CreateObject("CxEditors.CxCvsEditor")
CvsEditor.Connect("[5410]CYGDEMO.DBS")
End Sub
Disconnect
The Disconnect method disconnects from the connected service.
Syntax
Disconnect() As Integer
Remarks
The Disconnect method returns 0 if successful and a non-zero value if the disconnect failed.
Example
The following example disconnects the Client object from the connected service, and pops a message box if it is unsuccessful:
Sub Svc.Disconnect()
<SvcClient>.Disconnect()
MsgBox "Service has disconnected."
If <SvcClient>.Disconnect <> 0
Then
MsgBox "Failed to disconnect."
End If
End Sub
Edit
The Edit method launches an editor dialog box initialized with the information in the specified record.
Syntax
Edit(PointTag As String) As Integer
Parameters
| Parameter | Required | Description |
|---|---|---|
|
PointTag |
Yes |
The point tag of the record to edit. The point tag can be in one of the following forms:
|
Remarks
This method returns one of the following values:
| -1 or 0 | An error occurred. | |
| 1 | OK button was pressed. | |
| 2 | Cancel button was pressed. |
Example
The following example launches a dialog box for record "CYGDEMO.UIS.0000012345".
Properties
The Properties method launches a DBS Properties dialog box for the specified point tag.
Syntax
Properties(ByVal PointTag As String) As Integer
Parameters
| Parameter | Required | Description |
|---|---|---|
|
PointTag |
Yes |
The point tag of the record to view. The point tag can be in one of the following forms:
|
Remarks
This method returns one of the following values:
| -1 or 0 | An error occurred. | |
| 1 | OK button was pressed. | |
| 2 | Cancel button was pressed. |
Example
The following example launches the specified editor dialog box for the record "0000012345":


