CvsClient Methods

The CvsClient object contains the following methods:

Methods ending in Ex represent extended messaging functionality, for example, getting and storing the Long Point Id in the entry record, and getting and storing extended value fields, e.g., TimeStampType, UserStatus, and ValueType fields.

A description for each variant object can be found in CxCvsLib Helper Objects.

AlphaGet

Syntax

AlphaGet(Request As AlphaGetReq, Response As AlphaGetResp) As Integer

Parameters

AlphaGetRtREx

Syntax

AlphaGetRtREx (Request As AlphaGetRtRExReq, Response As AlphaGetRtRExResp) As Integer

Parameters

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
Sub TheView_EventInitialize()
    'Connect to a UIS
    Dim This : Set This = TheView
    CvsClient.Connect("[5410]CYGDEMO.UIS")
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

The following example disconnects from the CVS when the button is clicked.

1
2
3
4
5
6
7
8
9
10
Sub btnButton_EventClick()

Dim This : Set This = btnButton
    Dim iTest
    iTest = CvsClient.Disconnect()
    If iTest <> 0 Then
        MsgBox "Error in disconnecting"
    End If

End Sub

GetConsoleData

The GetConsoleData method returns the console text and display attributes as two 25x80 arrays of unsigned characters.

Syntax

GetConsoleData(ByRef pText, ByRef pAttr) As Integer

Parameters

Remarks

This method returns 0 if successful.

Example

The following example writes the console text and display attributes to a CSV file.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
Sub
    Dim aryText, aryAttr, nRet
    nRet = <NameofServiceClientObject>.GetConsoleData(aryText, aryAttr)
 
    ' Write text attributes to CSV file
    Dim i, j, strMsg
        For i = 0 To UBound(aryText, 1)
        For j = 0 To UBound(aryText, 2)
            strMsg = strMsg + CStr(aryText(i, j)) + ","
        Next
            strMsg = strMsg + vbCr
    Next
 
    dim fso, file
    Set fso = CreateObject("Scripting.FileSystemObject")
    Set file = fso.OpenTextFile("c:\console_text_attrs.csv", 2, True)
    file.WriteLine(strMsg)
    file.Close 
 
    strMsg = ""
 
    ' Write display attributes to CSV file
        For i = 0 To UBound(aryAttr, 1)
        For j = 0 To UBound(aryAttr, 2)
            strMsg = strMsg + CStr(aryAttr(i, j)) + ","
        Next
            strMsg = strMsg + vbCr
    Next
 
    Set file = fso.OpenTextFile("c:\console_disp_attrs.csv", 2, True)
    file.WriteLine(strMsg)
    file.Close 
 
    MsgBox nRet
End Sub

GetFacilityList

The GetFacilityList method returns a list of facility IDs in a CVS.

Syntax

GetFacilityList(ByRef FacilityList) As Integer

Parameters

GetNamedRec

Syntax

GetNamedRec(Request As GetNamedRecReq, Response As GetNamedRecResp) As Integer

Parameters

GetNamedRtREx

Syntax

GetNamedRtREx(Request As GetNamedRtRExReq, Response As GetNamedRtRExResp) As Integer

Parameters

GetNamedSRtREx

Syntax

GetNamedSRtREx(Request As GetNamedSRtRExReq, Response As GetNamedSRtRExResp) As Integer

Parameters

GetPointList

The GetPointList method returns a list of Short Point IDs.

Syntax

GetPointList(Descriptor As String, ByRef PointList) As Integer

Parameters

GetRec

Syntax

GetRec(Request As GetRecReq, Response As GetRecResp) As Integer

Parameters

GetReferences

The GetReferences method refreshes the list of services referenced by the connected service.

Syntax

GetReferences() As Integer

Return Values

This method returns all references for the connected service.

Example

The following example refreshes the connected services:

1
2
3
4
5
6
Sub GetReferences()
 
    <NameofServiceClientObject>.GetReferences
    MsgBox "Services references retrieved"

End Sub

The following example refreshes the referenced services.

1
2
3
4
5
6
7
8
Sub GetReferences()
    'Create and initialize the CVS Client
    Dim CvsClient
    Set CvsClient = CreateObject("CxCvs.CvsClient")
    CvsClient.Connect("CYGDEMO.UIS")
     
    uisClient.GetReferences()
End Sub

GetRefs

Syntax

GetRefs(Request As GetRefsReq, Response As GetRefsResp) As Integer

Parameters

GetRtREx

Syntax

GetRtREx(Request As GetRtRExReq, Response As GetRtRExResp) As Integer

Parameters

GetShortNamedRec

Syntax

GetShortNamedRec(Request As GetShortNamedRecReq, Response As GetShortNamedRecResp) As Integer

Parameters

GetShortRec

Syntax

GetShortRec(Request As GetShortRecReq, Response As GetShortRecResp) As Integer

Parameters

GetSNamedRtREx

Syntax

GetSNamedRtREx(Request As GetSNamedRtRExReq, Response As GetSNamedRtRExResp) As Integer

Parameters

GetSRtREx

Syntax

GetSRtREx(Request As GetSRtRExReq, Response As GetSRtRExResp) As Integer

Parameters

MatchName

Syntax

MatchName(Request As MatchNameReq, Response As MatchNameResp) As Integer

Parameters

MatchNamedRtREx

Syntax

MatchNamedRtREx(Request As MatchNamedRtRExReq, Response As MatchNamedRtRExResp) As Integer

Parameters

ResolvePoints

The ResolvePoints method resolves a list of facility UDCs or Long Point IDs.

Syntax

ResolvePoints(TagList, ByRef PointList) As Integer

Parameters

SetRecord

Syntax

SetRecord(Request As SetRecordReq, Response As SetRecordResp) As Integer

Parameters

SetRtREx

Syntax

SetRtREx(Request As SetRtRExReq, Response As SetRtRExResp) As Integer

Parameters