COM method signatures - Metasys - LIT-12013522 - Software Application - Basic Services client library for .NET (and COM) - Metasys API - 4.2

Global client As LegacyMetasysClient

Public Sub CreateClientandLogin()
  If client Is Nothing Then
    'Init legacy client using the IP address (or server name)
    Set client = clientFactory.GetLegacyClient("xxx.xxx.xxx.xxx", True, "v3", "en-US")
    Dim token As IComAccessToken
    'Login using the windows credential manager
    Set token = client.TryLoginWithCredMan("<credman_name>")
  End If
End Sub

Global client As LegacyMetasysClient

Public Sub CreateClientandLogin()
  If client Is Nothing Then
    'Init legacy client using the IP address (or server name)
    Set client = clientFactory.GetLegacyClient("xxx.xxx.xxx.xxx", True, "v3", "en-US")
    Dim token As IComAccessToken
    'Login using the credentials (user and password) and get the token
    Set token = client.TryLogin("<username>", "<password>")
  End If
End Sub

Public Function GetObjectGUID(byval fqr as string) As String
'Example of parameter value:
' fqr = "WIN-21DJ9JV9QH6:EECMI-NCE25-2/AV1"
  Get the object GUID associated to the object FQR
  Dim result As String: result =""
  objectGUID = client.GetObjectIdentifier(fqr)

GetObjectGUID = result 
End Function

Public Function ReadProperty(ByVal fqr As String, ByVal prop As String) As String
'Example of parameter values:
' fqr = "WIN-21DJ9JV9QH6:EECMI-NCE25-2/AV1"
' prop ="presentValue"
  'Get first the GUID of the Object specified by the 'fqr'
  Dim objId As String
  objId = client.GetObjectIdentifier(fqr)
  'Get the value of the property specified by 'prop'
  Dim res As ComVariant
  Set res = client.ReadProperty(objId, prop)
'Return the read value
ReadProperty = res.stringValue
End Function

Public Function ReadProperties(ByVal objects As String, ByVal props As String) As String
' Example of parameter values:
' objects = "WIN-21DJ9JV9QH6:EECMI-NCE25-2/FCB.10FEC11 - V6 Unit.V5 Network Outdoor Temperature, WIN-21DJ9JV9QH6:EECMI-NCE25-2/FCB.10FEC11 - V6 Unit.V9 Network Outdoor Temperature, WIN-21DJ9JV9QH6:EECMI-NCE25-2/AV1"
' props = "name,description,presentValue"

  'Parse array objects
  Dim rawArray() As String
  Dim varArray() As String
  rawArray = Split(objects, ",")
  ReDim varArray(LBound(rawArray) To UBound(rawArray))
  Dim index As Long
  For index = LBound(rawArray) To UBound(rawArray)
    varArray(index) = client.GetObjectIdentifier(rawArray(index))
  Next index
  'Parse array props
  Dim rawArray2() As String
  Dim varArray2() As String
  rawArray2 = Split(props, ",")
  ReDim varArray2(LBound(rawArray2) To UBound(rawArray2))
  Dim index2 As Long
  For index2 = LBound(rawArray2) To UBound(rawArray2)
    varArray2(index2) = rawArray2(index2)
  Next index2
  Dim res() As Object
  res = client.ReadPropertyMultiple(varArray, varArray2)
  Dim rows As Long
  rows = UBound(res) + 1
  If (rows > 0) Then
    'Extract Item reference and put it in a var array
    Dim varArray5() As Variant
    ReDim varArray5(rows)
    Dim i As Integer
    Dim m As IComVariantMultiple
    Dim variants() As Object
    Dim o As IComVariant
    For i = 0 To UBound(res)
      Set m = res(i)
      ReDim variants(UBound(m.values))
      variants = m.values
      Set o = variants(i)
      varArray5(i) = o.stringValue
    Next
    'Write the results in a string (where the values are separated by a ',')
    ReadProperties = ArrayToDelimited(varArray5, ",")
  End If
End Function

Public Function WriteProp(Byval fqr As String, prop As String, newValue As String) As String
On Error GoTo Alert
  Dim objId As String
  'Get the Object GUID according to the 'fqr'
  objId = client.GetObjectIdentifier(fqr)
  'Write the 'newValue' into the property 'prop'
  client.WriteProperty objId, prop, newValue
  'Return the result
  WriteMsProp = "Successfully done."
Done:
  Exit Function
Alert:
  'Return the error message
  WriteMsProp = "Error: " & Err.Description
End Function

Public Function WriteMsProps(objects As String, props As String, values As String) As String
' Example of parameter values:
' objects = "WIN-21DJ9JV9QH6:EECMI-NCE25-2/FCB.10FEC11 - V6 Unit.E4 Network Outdoor Temperature,WIN-21DJ9JV9QH6:EECMI-NCE25-2/FCB.10FEC11 - V6 Unit.V9 Network Outdoor Temperature, WIN-21DJ9JV9QH6:EECMI-NCE25-2/FCB.10FEC11 - V6 Unit.E4 Network Outdoor Temperature"
' props = "name,description"
' values = "MyTest,MyTest Description"
On Error GoTo Alert
  Parse array objects
  im rawArray() As String
  im varArray() As String
  awArray = Split(objects, ",")
  eDim varArray(LBound(rawArray) To UBound(rawArray))
  im index As Long
  or index = LBound(rawArray) To UBound(rawArray)
    varArray(index) = client.GetObjectIdentifier(rawArray(index))
  Next index
  'Parse array props
  Dim rawArray2() As String
  Dim varArray2() As String
  rawArray2 = Split(props, ",")
  ReDim varArray2(LBound(rawArray2) To UBound(rawArray2))
  Dim index2 As Long
  For index2 = LBound(rawArray2) To UBound(rawArray2)
    varArray2(index2) = rawArray2(index2)
  Next index2
  'Parse array values
  Dim rawArray3() As String
  Dim varArray3() As String
  rawArray3 = Split(values, ",")
  ReDim varArray3(LBound(rawArray3) To UBound(rawArray3))
  Dim index3 As Long
  For index3 = LBound(rawArray3) To UBound(rawArray3)
    varArray3(index3) = rawArray3(index3)
  Next index3
  client.WritePropertyMultiple varArray, varArray2, varArray3
  WriteMsProps = "Successfully done."
Done:
  Exit Function
Alert:
  WriteMsProps = "Error: " & Err.Description
End Function

Public Function GetObjectCmds(ByVal fqr As String) As ComCommand()
  'Get first the GUID of the Object specified by the 'fqr'
  Dim objId As String
  objId = client.GetObjectIdentifier(fqr)
  'Get the value of the specified by property 'prop'
  Dim res() As ComCommand
  res = client.GetCommands(objId)
'Return the values
GetObjectCmds = res()
End Function

Public Function SendMsCommand(fqr As String, command As String, Optional values As String) As String
'Example of parameter values:
' fqr = "WIN-21DJ9JV9QH6:EECMI-NCE25-2/AV1"
' command = "adjust"
' values = "25"
On Error GoTo Alert
  Dim objId As String
  objId = client.GetObjectIdentifier(fqr)
  If IsMissing(values) = False And Trim(values & vbNullString) <> vbNullString Then
    Dim varArray() As String
    'Parse array objects
    Dim rawArray() As String
    rawArray = Split(values, ",")
    ReDim varArray(LBound(rawArray) To UBound(rawArray))
    Dim index As Long
    For index = LBound(rawArray) To UBound(rawArray)
      varArray(index) = rawArray(index)
    Next index
    client.SendCommand objId, command, varArray
  Else
    client.SendCommand objId, command
  End If
  SendMsCommand = "Successfully done."
Done:
  Exit Function
Alert:
  SendMsCommand = "Error: " & Err.Description
End Function

Public Function GetNetworkDevices() As String
'This function returns the FQR of all the network devices separated by ','
On Error GoTo Alert
  Dim result As String: result = ""
  'Get the network device objects
  Dim res() As Object
  res = client.GetNetworkDevices()
  Dim rows As Long
  rows = UBound(res) + 1
  If (rows > 0) Then
    'Extract Item reference and put it in a var array
    Dim varArray() As Variant
    ReDim varArray(rows)
    Dim i As Integer
    Dim o As IComMetasysObject
    For i = 0 To UBound(res)
      Set o = res(i)
      result = result & o.ItemReference & ","
    Next
  End If
  'Return the result
  GetNetworkDevices = result
Done:
  Exit Function
Alert:
  'Return the error message
  GetNetworkDevices = "The following error occurred: " & Err.Description
End Function

Public Function GetObjects(fqr As String, levels As String) As String
On Error GoTo Alert
  Dim result As String: result = ""
  Dim objId As String
  objId = client.GetObjectIdentifier(fqr)
  Dim res() As Object
  ' Note: this is possible because the return type is an object
  res = client.GetObjects(objId, levels)
  ' Check response
  Dim rows As Long
  rows = UBound(res) + 1
  If (rows > 0) Then
    Dim i As Integer
    Dim o As IComMetasysObject
    For i = 0 To UBound(res)
      Set o = res(i)
      ' Extract children when available
      If o.ChildrenCount > 0 Then
        Dim children() As Object
        children = o.children
        Dim c As IComMetasysObject
        Dim j As Integer
        For j = 0 To (o.ChildrenCount - 1)
          Set c = children(j)
          result = result & c.ItemReference & ","
        Next
      End If          
      result = result & o.ItemReference & ","
    Next
  End If
  'Return the result
  GetObjects = result
Done:
  Exit Function
Alert:
  'Return the error message
  GetObjects = "The following error occurred: " & Err.Description
End Function

Public Function GetSpaces() As String
On Error GoTo Alert
  Dim result As String: result = ""
  'Return the read value
  Dim res() As Object
  res = client.GetSpaces()
  Dim rows As Long
  rows = UBound(res) + 1
  If (rows > 0) Then
    'Extract Item name and concatenate it in a string
    Dim i As Integer
    Dim o As IComMetasysObject
    For i = 0 To UBound(res)
      Set o = res(i)
      result = result & o.Name & ","
    Next
  End If
  'Return the result
  GetSpaces = result
Done:
  Exit Function
Alert:
  'Return the error message
  GetSpaces = "The following error occurred: " & Err.Description
End Function

Public Function GetSpaceTypes() As String
On Error GoTo Alert
  Dim result As String: result = ""
  'Return the read value
  Dim res() As Object
  res = client.GetSpaceTypes()
  Dim rows As Long
  rows = UBound(res) + 1
  If (rows > 0) Then
    'Extract Item description and concatenate it in a string
    Dim i As Integer
    Dim o As IComMetasysObjectType
    For i = 0 To UBound(res)
      Set o = res(i)
      Result = result & o.Description & ","
    Next
  End If
  'Return the result
  GetSpaceTypes = result
Done:
  Exit Function
Alert:
'Return the error message
  GetSpaceTypes = "The following error occurred: " & Err.Description
End Function

Public Function GetEquipments() As String
On Error GoTo Alert
  Dim result As String: result = ""
  'Return the read value
  Dim res() As Object
  res = client.GetEquipment()
  Dim rows As Long
  rows = UBound(res) + 1
  If (rows > 0) Then
    'Extract Item name and concatenate it in a string
    Dim i As Integer
    Dim o As IComMetasysObject
    For i = 0 To UBound(res)
      Set o = res(i)
      GetEquipments = GetEquipments & o.Name & ","
  Next
    End If
    GetEquipments = result
Done:
  Exit Function
Alert:
  GetEquipments = "The following error occurred: " & Err.Description
End Function

Public Function GetSpaceEquipments(ByVal spaceID As String) As String
'Example of parameter value:
' spaceID = "2a26bb37-4f30-5d0d-899a-752c535a3be2" (GUID of a space object)
On Error GoTo Alert
  Dim result As String: result = ""
  'Return the equipments associated to a space
  Dim res2() As Object
  res2 = client.GetSpaceEquipment(spaceID)
  Dim rows As Long
  rows = UBound(res2) + 1
  If (rows > 0) Then
    'Extract Item name and concatenate it in a string
    Dim i As Integer
    Dim o As IComMetasysObject
    For i = 0 To UBound(res2)
      Set o = res2(i)
      result = result & o.Name & ","
    Next
  End If
  'Return the result
  GetSpaceEquipments = result
Done:
  Exit Function
Alert:
'Return the error message
  GetSpaceEquipments = "The following error occurred: " & Err.Description
End Function

Public Function GetSpaceChildren(ByVal spaceID As String) As String
'Example of parameter value:
' spaceID = "2a26bb37-4f30-5d0d-899a-752c535a3be2" (GUID of a space object)
On Error GoTo Alert
  Dim result As String: result = ""
  'Return the spaces (children) associated to a space
  Dim res2() As Object
  res2 = client.GetSpaceChildren(spaceID)
  Dim rows As Long
  rows = UBound(res2) + 1
  If (rows > 0) Then
    'Extract Item name and concatenate it in a string
    Dim i As Integer
    Dim o As IComMetasysObject
    For i = 0 To UBound(res2)
      Set o = res2(i)
      result = result & o.Name & ","
    Next
  End If
  'Return the result
  GetSpaceChildren = result
Done:
  Exit Function
Alert:
'Return the error message
  GetSpaceChildren = "The following error occurred: " & Err.Description
End Function

Public Function GetEquipmentPoints(ByVal equipmentID As String) As String
'Example of parameter value:
' equipmentID = "cb2b651e-9a4a-5b51-8165-d7c4b18419ad"
On Error GoTo Alert
  Dim result As String: result = ""
  'Return the read value
  Dim res() As Object
  res = client.GetEquipmentPoints(equipmentID)
  Dim rows As Long
  rows = UBound(res) + 1
  If (rows > 0) Then
    'Extract Item shortname and concatenate it in a string
    Dim i As Integer
    Dim o As IComMetasysPoint
    Dim val As IComVariant
    For i = 0 To UBound(res)
      Set o = res(i)
      Set val = o.PresentValue
      result = result & o.ShortName + ","
    Next
  End If
  GetEquipmentPoints = result
Done:
  Exit Function
Alert:
  GetEquipmentPoints = "The following error occurred: " & Err.Description
End Function

Public Function ReadAlarms() As String
On Error GoTo Alert
  Dim result As String: result = ""
  'Return the read value
  Dim filter As New ComAlarmFilter
  filter.StartTime = "2020-01-10T08:10:20.243Z"
  filter.EndTime = "2020-06-02T09:10:20.243Z"
  filter.PageSize = 100
  filter.PriorityRange = "0,100"
  Dim alarmsPager As ComPagedResult
  Set alarmsPager = client.GetAlarms(filter)
  Dim total As Long
  total = alarmsPager.total
  If (total > 0) Then
    'Extract Item reference and put it in a var array
    Dim i As Integer
    Dim a As ComAlarm
    Dim alarms() As Object
    alarms = alarmsPager.Items
    For i = 0 To UBound(alarms)
      Set a = alarms(i)
      result = result & CStr(a.ID) & ","
    Next
  End If
  'Return the result
  ReadAlarms = result
Done:
  Exit Function
Alert:
'Return the error message
  ReadAlarms = "The following error occurred: " & Err.Description
End Function

Public Function ReadSingleAlarm(ByVal alarmId As String) As String
On Error GoTo Alert
  Dim result As String: result = ""
  Dim alarm As ComAlarm
  'Get the alarm using its GUID
  Set alarm = client.GetSingleAlarm(alarmId)
  If Not (alarm Is Nothing) Then
    'Extract Item FQR use it as the result of this function
    result = CStr(alarm.ItemReference)
  End If
  'Return the result
  ReadSingleAlarm = result
Done:
  Exit Function
Alert:
  ReadSingleAlarm = "The following error occurred: " & Err.Description
End Function

Public Function ReadAlarmsForAnObject(objectId As String) As String
On Error GoTo Alert
Dim result As String: result = ""
'Set the filter
  Dim filter As New ComAlarmFilter
  filter.StartTime = "2020-08-15T08:10:20.243Z"
  filter.EndTime = "2020-08-20T08:10:20.243Z"
  filter.ExcludeAcknowledged = True
  Dim alarmsPager As ComPagedResult
  'Get the alarms associated to the object ID (GUID)
  Set alarmsPager = client.GetAlarmsForObject(objectId, filter)
  Dim total As Long
  total = alarmsPager.total
  If (total > 0) Then
    'Extract Item reference and concatenate it in a string
    Dim i As Integer
    Dim a As ComAlarm
    Dim alarms() As Object
    ReDim alarms(total)
    alarms = alarmsPager.Items
    For i = 0 To UBound(alarms)
      Set a = alarms(i)
      result = result & CStr(a.ID) & ","
    Next
  End If
  'Return the result
  ReadAlarmsForAnObject = result
Done:
  Exit Function
Alert:
  ReadAlarmsForAnObject = "The following error occurred: " & Err.Description
End Function

Public Function ReadAlarmsForNetworkDevice(ByVal networkDeviceId As String) As String
On Error GoTo Alert
  Dim result As String: result = ""
  'Set the filter object
  Dim filter As New ComAlarmFilter
  filter.StartTime = "2020-05-18T08:10:20.243Z"
  filter.EndTime = "2020-06-18T09:10:20.243Z"
  Dim alarmsPager As ComPagedResult
  'Get the alarms assaciated to the network device Id (GUID)
  Set alarmsPager = client.GetAlarmsForNetworkDevice(networkDeviceId, filter)
  Dim total As Long
  total = alarmsPager.total
  If (total > 0) Then
    'Extract alarm GUID and concatenate it in a string
    Dim i As Integer
    Dim a As ComAlarm
    Dim alarms() As Object
    ReDim alarms(total)
    alarms = alarmsPager.Items
    For i = 0 To UBound(alarms)
      Set a = alarms(i)
      result = result & CStr(a.ID) & ","
    Next
  End If
  'Return the result
  ReadAlarmsForNetworkDevice = result
Done:
  Exit Function
Alert:
  'Return the error message
  ReadAlarmsForNetworkDevice = "The following error occurred: " & Err.Description
End Function

Public Function ReadAlarmAnnotations(ByVal alarmId As String) As String
On Error GoTo Alert
  Dim result As String: result = ""
  Dim res() As IComAlarmAnnotation
  'Get the alarm annotations associated to the alarm ID (GUID)
  res = client.GetAlarmAnnotations(alarmId)
  Dim rows As Long
  rows = UBound(res) + 1
  If (rows > 0) Then
    'Extract the alarm annotation text and concatenate it in a string
    Dim i As Integer
    For i = 0 To UBound(res)
      result = result & CStr(res(i).Text) & ","
    Next
  End If
  'Return the result
  ReadAlarmAnnotations = result
Done:
  Exit Function
Alert:
  'Return the error message
  ReadAlarmAnnotations = "The following error occurred: " & Err.Description
End Function

Public Function ReadSamples(ByVal objId As String, ByVal attributeId As Integer) As String
'Example of parameter values:
' objId = "3dfb7f09-2465-5520-b2d8-046e3b5ce80a"
' attributeId = 85
On Error GoTo Alert
  Dim result As String: result = ""
  'Set the filter to get the samples
  Dim filter As New ComTimeFilter
  filter.StartTime = "2020-06-04T08:10:20.243Z"
  filter.EndTime = "2020-06-06T09:10:20.243Z"
  Dim samplesPager As ComPagedResult
  Set samplesPager = client.GetSamples(objId, attributeId, filter)
  'Extract Items  and put it in a var array
  Dim rows As Long
  rows = UBound(samplesPager.Items) + 1
  If (rows > 0) Then
    Dim i As Integer
    Dim s As ComSample
    Dim samples() As Object
    ReDim samples(rows)
    samples = samplesPager.Items
    For i = 0 To UBound(samples)
      'Extract the sample value and concatenate it in a string
      Set s = samples(i)
      result = result & CStr(s.Value) & ","
    Next
  End If
  'Return the result
  ReadSamples = result
Done:
  Exit Function
Alert:
  ReadSamples = "The following error occurred: " & Err.Description
End Function

Public Function ReadTrendedAttributes(ByVal objId As String) As String
'Example of parameter value:
' objId = "3dfb7f09-2465-5520-b2d8-046e3b5ce80a"
On Error GoTo Alert
  Dim result As String: result = ""
  'Get Trended attributes
  Dim res() As ComMetasysAttribute
  res = client.GetTrendedAttributes(objId)
  Dim attr As ComMetasysAttribute
  Dim rows As Long
  rows = UBound(res) + 1
  If (rows > 0) Then
    'Extract the tred attribute ID and concatenate it in a string
    Dim i As Long
    For i = 0 To UBound(res)
      result = result & CStr(res(i).ID) & ","
    Next
  End If
  'Return the result
  ReadTrendedAttributes = result
Done:
  Exit Function
Alert:
  ReadTrendedAttributes = "The following error occurred: " & Err.Description
End Function

Public Function ReadAudits() As String
On Error GoTo Alert
  Dim result As String: result = ""
  'Set the object to filter the audits
  Dim filter As New ComAuditFilter
  filter.StartTime = "2020-05-05T08:10:20.243Z"
  filter.EndTime = "2020-06-02T09:10:20.243Z"
  filter.PageSize = 100
  filter.OriginApplications = "0,1,2"
  'Get the audits according to the filter
  Dim auditsPager As ComPagedResult
  Set auditsPager = client.GetAudits(filter)
  Dim total As Long
  total = auditsPager.total
  If (total > 0) Then
    'Extract audit ID and concatenate it in a string
    Dim i As Integer
    Dim a As ComAudit
    Dim audits() As Object
    audits = auditsPager.Items
    For i = 0 To UBound(audits)
      Set a = audits(i)
      result = result & CStr(a.ID) & ","
    Next
  End If
  'Return the result
  ReadAudits = result
Done:
  Exit Function
Alert:
  'Return the error message
  ReadAudits = "The following error occurred: " & Err.Description
End Function

Public Function ReadSingleAudit(ByVal auditId As String) As String
'Example of parameter value:
' auditId = "f225f75a-3bae-4b41-9126-8430a6d62178"
On Error GoTo Alert
  Dim result As String: result = ""
  Dim audit As ComAudit
  'Get the alarm using its GUID
  Set audit = client.GetSingleAudit(auditId)
  If Not (audit Is Nothing) Then
    'Extract audit ID and use it as the result of this function
    result = CStr(audit.ID)
  End If
  'Return the result
  ReadSingleAudit = result
Done:
  Exit Function
Alert:
  ReadSingleAudit = "The following error occurred: " & Err.Description
End Function

Public Function ReadAuditsForAnObject(ByVal objectId As String) As String
'Example of parameter value:
' objectId = "21c605fb-4755-5d65-8e9f-4fc8283b0366"
On Error GoTo Alert
  Dim result As String: result = ""
  'Set the filter
  Dim filter As New ComAuditFilter
  filter.StartTime = "2020-08-15T08:10:20.243Z"
  filter.EndTime = "2020-08-20T08:10:20.243Z"
  filter.PageSize = 100
  Dim auditsPager As ComPagedResult
  'Get the audits associated to the object Id
  Set auditsPager = client.GetAuditsForObject(objectId, filter)
  Dim total As Long
  total = auditsPager.total
  If (total > 0) Then
    'Extract audit ID (GUID) and concatenate it in a string
    Dim i As Integer
    Dim a As ComAudit
    Dim audits() As Object
    ReDim audits(total)
    audits = auditsPager.Items
    For i = 0 To UBound(audits)
      Set a = audits(i)
      result = result & CStr(a.ID) & ","
Next
  End If
  'Return the result
  ReadAuditsForAnObject = result
Done:
  Exit Function
Alert:
  ReadAuditsForAnObject = "The following error occurred: " & Err.Description
End Function

Public Function ReadAuditAnnotations(ByVal auditId As String) As String
'Example of parameter value:
' auditId = "f225f75a-3bae-4b41-9126-8430a6d62178"
On Error GoTo Alert
  Dim result As String: result = ""
  'Get the annotations associated to the audit Id
  Dim res() As Object
  res = client.GetAuditAnnotations(auditId)
  Dim rows As Long
  rows = UBound(res) + 1
  If (rows > 0) Then
    'Extract the audit annotation text and concatenate it in a string
    Dim i As Integer
    Dim m As IComAuditAnnotation
    For i = 0 To UBound(res)
      Set m = res(i)
      result = result & m.Text & ","
    Next
  End If
  'Return the result
  ReadAuditAnnotations = result
Done:
  Exit Function
Alert:
  'Return the error message
  ReadAuditAnnotations = "The following error occurred: " & Err.Description
End Function

Public Function AddSingleAuditAnnotation(ByVal auditId As String, ByVal text As String) As String
'Example of parameter values:
' auditId = "f225f75a-3bae-4b41-9126-8430a6d62178"
' text = "ANNOTATION TO ADD"
On Error GoTo Alert
  'Add the audit annotation to the audit specified by the audit Id
  client.AddAuditAnnotation auditId, text
  'Return the result (if no errors occur)
  AddSingleAuditAnnotation = "Successfully done."
Done:
  Exit Function
Alert:
  'Return the error message
  AddSingleAuditAnnotation = "Error: " & Err.Description
End Function

Public Function AddAuditAnnotationMultiple(requestParams() As String)
'Example of parameter value:
'    Dim requestParams(1) As String
'    requestParams(0) = "f225f75a-3bae-4b41-9126-8430a6d62178|ANNOTATION TO ADD #1"
'    requestParams(1) = "f225f75a-3bae-4b41-9126-8430a6d62178|ANNOTATION TO ADD #2"
On Error GoTo Alert
  Dim result As String: result = ""
  'Add multiple audit annotations
  Dim res() As String
  res = client.AddAuditAnnotationMultiple(requestParams)
  Dim rows As Long
  rows = UBound(res) + 1
  If (rows > 0) Then
    'Extract Item reference and put it in a var array
    Dim i As Integer
    For i = 0 To UBound(res)
      result = result & res(i) & ","
    Next
  End If
  'Return the result
  AddAuditAnnotationMultiple = result
Done:
  Exit Function
Alert:
  'Return the error message
  AddAuditAnnotationMultiple = "The following error occurred: " & Err.Description
End Function

Public Function DiscardSingleAudit(ByVal auditId As String, ByVal text As String) As String
'Example of parameter values:
' auditId = "1b3b3127-a703-42b7-bb9a-7527331e329d"
' text = "DISCARD AUDIT ANNOTATION"
On Error GoTo Alert
  'Discard the audit specified by the audit Id (and add an annotation to it)
  client.DiscardAudit auditId, text
  'Return the result (if no errors occur)
  DiscardSingleAudit = "Successfully done."
Done:
  Exit Function
Alert:
  'Return the error message
  DiscardSingleAudit = "Error: " & Err.Description
End Function

Public Function DiscardAuditMultiple(requestParams() As String) As String
'Example of parameter value:
'    Dim requestParams(1) As String
'    requestParams(0) = "1b3b3127-a703-42b7-bb9a-7527331e329d|DISCARD ANNOTATION AUDIT#1"
'    requestParams(1) = "e3b6cbcf-cf05-43ed-b845-7321c8b86c38|DISCARD ANNOTATION AUDIT#2"
On Error GoTo Alert
  Dim result As String:   result = ""
  'Discard multiple audit (and add an annotation to them)
  Dim res() As String
  res = client.DiscardAuditMultiple(requestParams)
  Dim rows As Long
  rows = UBound(res) + 1
  If (rows > 0) Then
    'Extract Item reference and put it in a var array
    For i = 0 To UBound(res)
      result = result & CStr(res(i)) & ","
    Next
  End If
  'Return the result
  DiscardAuditMultiple = result
Done:
  Exit Function
Alert:
  'Return the error message
  MsgBox "The following error occurred: " & Err.Description
End Function