Scripting > CxEditors > CxGrpEditor Object > CxGrpEditor Methods

CxGrpEditor Methods

The CxGrpEditor object contains the following methods:

Configure

The Configure method launches a Group Service Metadata dialog box, which is used to configure GRP metadata.

Syntax

Configure() As Integer

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 a Group Service Metadata dialog box.

Sub

Dim iRet

iRet= GrpEditor.Configure

MsgBox iRet

End Sub

Back to top

Connect

The Connect method connects to a GRP.

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

Example

The following example creates and connects the CxGrpEditor object.

Sub

Dim GrpEditor

Set GrpEditor = CreateObject("CxEditors.CxGrpEditor")

GrpEditor.Connect("[5410]CYGDEMO.GRP")

End Sub

Back to top

Copy

The Copy method launches a Create Node property sheet initialized with the information in the specified record.

Syntax

Copy(QueueKey As String) As Integer

Parameters

Parameter Required Description

QueueKey

Yes

The database queue key of the record to copy.

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 Create Node property sheet for record "0000000001."

Sub

Dim iRet

iRet= GrpEditor.Copy("0000000001")

MsgBox iRet

End Sub

Back to top

Delete

The Delete method launches a Delete Node property sheet initialized with the information in the specified record.

Syntax

Delete(QueueKey As String) As Integer

Parameters

Parameter Required Description

QueueKey

Yes

The database queue key of the record to delete.

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 Delete Node property sheet for record "0000000001."

Sub

Dim iRet

iRet= GrpEditor.Delete("0000000001")

MsgBox iRet

End Sub

Back to top

Disconnect

The Disconnect method disconnects from the connected GRP service.

Syntax

Disconnect()

Example

The following example disconnects the GrpEditor object.

Sub

GrpEditor.Disconnect

End Sub

Back to top

Edit

The Edit method launches a property sheet for the specified record.

Syntax

Edit(QueueKey As String) As Integer

Parameters

Parameter Required Description

QueueKey

Yes

The database queue key of the record to edit.

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 property sheet for record "0000000001."

Sub

Dim iRet

iRet= GrpEditor.Edit("0000000001")

MsgBox iRet

End Sub

Back to top

Find

This method is unimplemented.

New

The New method launches a Create Node property sheet.

Syntax

New() As Integer

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 Create Node property sheet.

Sub

Dim iRet

iRet= GrpEditor.New

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.