CxGnsDbEditor Methods

The CxGnsDbEditor object contains the following methods:

Connect

The Connect method connects the object to a service.

Syntax

Connect(DomainSiteService As String)

Parameters

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:

1
2
3
4
5
6
7
Sub

    Dim GnsDbEditor
    Set GnsDbEditor = CreateObject("CxEditors.CxGnsDbEditor")
    GnsDbEditor.Connect("[5410]CYGDEMO.GNS")

End Sub

Copy

The Copy method launches a New GNS Entry dialog box initialized with the information in the specified record.

Syntax

Copy(QueueKey As String) As Integer

Parameters

Remarks

This method returns one of the following values:

Example

The following example launches a Copy or New dialog box for the record "0000012345."

1
2
3
4
5
6
7
8
Sub Copy()

    Dim iRet
    iRet = <SvcClient>.Copy("0000012345")
 
    MsgBox iRet

End Sub

The following example launches a New GNS Entry dialog box for record "MYRECORD."

1
2
3
4
5
6
7
8
9
Sub

    Dim iKey
    iKey = GnsDbEditor.Find("MYRECORD")
    Dim iRet
    iRet= GnsDbEditor.Copy(iKey)
    MsgBox iRet

End Sub

Delete

The Delete method launches a Delete GNS Entry dialog box initialized with the information in the specified record.

Syntax

Delete(QueueKey As String) As Integer

Parameters

Remarks

This method returns one of the following values:

Example

The following example launches the specified Delete dialog box for record "0000012345":

1
2
3
4
5
6
7
8
Sub

    Dim iRet
    iRet = <SvcEditor>.Delete("0000012345")
 
    MsgBox iRet
    
End Sub

The following example launches a Delete GNS Entry dialog box for record "MYRECORD."

1
2
3
4
5
6
7
8
9
10
Sub

    Dim iKey
    iKey = GnsDbEditor.Find("MYRECORD")
 
    Dim iRet
    iRet= GnsDbEditor.Delete(iKey)
    MsgBox iRet
    
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:

1
2
3
4
5
6
7
8
9
10
11
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(QueueKey As String) As Integer

Parameters

Remarks

This method returns one of the following values:

Example

The following example launches an editor dialog box for the record "0000012345":

1
2
3
4
5
6
7
8
Sub

    Dim iRet
    
    iRet = <SvcEditor>.Edit("0000012345")
     MsgBox iRet
    
End Sub

The following example launches a dialog box for record "MYRECORD."

1
2
3
4
5
6
7
8
9
10
Sub

    Dim iKey
    iKey = GnsDbEditor.Find("MYRECORD")
     
    Dim iRet
    iRet= GnsDbEditor.Edit(iKey)
    MsgBox iRet

End Sub

Find

The Find method returns the database queue key for the specified GNS ID.

Syntax

Find(GnsId As String) As Integer

Parameters

Remarks

This method returns an error if the GNS ID is not found in the connected GNS.

Example

The following example displays the database queue key for the record with ID "MYRECORD.".

1
2
3
4
5
6
7
Sub

    Dim iRet
    iRet= GnsDbEditor.Find("MYRECORD")
    MsgBox iRet

End Sub

New

The New method launches a New Entry dialog box.

Syntax

New() As Integer

Remarks

This method returns one of the following values:

Example

The following example launches the specified editor dialog box:

1
2
3
4
5
6
7
8
Sub

    Dim iRet
    iRet = <SvcEditor>.New
 
    MsgBox iRet
    
End Sub