Scripting > CxEditors > CxDbsEditor Object > CxDbsEditor Methods

CxDbsEditor Methods

The CxDbsEditor object contains the following methods:

Connect

The Connect method connects to a DBS.

Syntax

Connect(DomainSiteService As String)

Parameters

Parameter Required Description

DomainSiteService

Yes

The [Domain]Site.Service to which to connect.  A domain is optional. The service must be a valid DBS.

Example

The following example creates and connects the CxDbsEditor object.

Sub

Dim DbsEditor

Set DbsEditor = CreateObject("CxEditors.CxDbsEditor")

DbsEditor.Connect("[5410]CYGDEMO.DBS")

End Sub

Back to top

Disconnect

The Disconnect method disconnects from the connected DBS service.

Syntax

Disconnect()

Example

The following example disconnects the DbsEditor object.

Sub

DbsEditor.Disconnect

End Sub

Back to top

View

The View method launches a DBS Properties dialog box for the specified database key, that is used to view record details.

Syntax

View(Key As String, EditEnabled As Boolean) As Integer

Parameters

Parameter Required Description

Key

Yes

The database queue key of the record to view.

EditEnabled

Yes

Set to true to enable editing of the property sheet.

Remarks

This method returns one of the following values:

  -1 or 0 An error occurred.
  2 Close button was pressed.

Example

The following example launches DBS Properties dialog box for the record with key "0000000048."

Sub

Dim iRet

iRet= DbsEditor.View("0000000048", True)

 

MsgBox iRet

End Sub

Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.