Scripting > CxEditors > CxUisEditor Object > CxUisEditor Methods

CxUisEditor Methods

The CxUisEditor object contains the following methods:

Connect

The Connect method connects to a UIS.

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 UIS.

Example

The following example creates and connects the CxUisEditor object.

Sub

Dim UisEditor

Set UisEditor = CreateObject("CxEditors.CxUisEditor")

UisEditor.Connect("[5410]CYGDEMO.UIS")

End Sub

Back to top

Copy

This method is unimplemented.

Back to top

Delete

This method is unimplemented.

Back to top

Disconnect

The Disconnect method disconnects from the connected UIS service.

Syntax

Disconnect()

Example

The following example disconnects the UisEditor object.

Sub

UisEditor.Disconnect

End Sub

Back to top

Edit

This method is unimplemented.

Back to top

New

This method is unimplemented.

Back to top

ViewCD

The ViewCD method launches a Device Information dialog box for the specified Comm Device.

Syntax

ViewCD(strDeviceId As String) As Integer

Parameters

Parameter Required Description

strDeviceId

Yes

The ID of the Comm Device to view.

Remarks

This method returns one of the following values:

  -1 or 0 An error occurred.
 

1

Dialog box closed successfully.

Example

The following example launches a Device Information dialog box for device "TCP210-3001."

Sub

Dim iRet

iRet= UisEditor.ViewCD("TCP210-3001")

MsgBox iRet

End Sub

Back to top

ViewED

The ViewED method launches a Device Information dialog box for the specified Import/Export Device.

Syntax

ViewED(strDeviceId As String) As Integer

Parameters

Parameter Required Description

strDeviceId

Yes

The ID of the Import/Export Device to view.

Remarks

This method returns one of the following values:

  -1 or 0 An error occurred.
 

1

Dialog box closed successfully.

Example

The following example launches a Device Information dialog box for device "ENTOPS."

Sub

Dim iRet

iRet= UisEditor.ViewED("ENTOPS")

MsgBox iRet

End Sub

Back to top

ViewRD

The ViewRD method launches a Device Information dialog box for the specified remote device.

Syntax

ViewRD(strDeviceId As String) As Integer

Parameters

Parameter Required Description

strDeviceId

Yes

The ID of the remote device to view.

Remarks

This method returns one of the following values:

  -1 or 0 An error occurred.
 

1

dialog box closed successfully.

Example

The following example launches a Device Information dialog box for device "FLOWAUTOAP15."

Sub

Dim iRet

iRet= UisEditor.ViewRD("FLOWAUTOAP15")

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.