Using Device API

[Wadenut]

I have a need to access the device API in order to retrieve device type and control use information.

Starting with this example directly from the HS3 Online Help:

Example:

Retrieve the DeviceTypeInfo object:

Dim DT as DeviceAPI.DeviceTypeInfo = Nothing
dv = hs.GetDeviceByRef(1234)
DT = dv.DeviceType_Get(hs)
If DT IsNot Nothing Then
...
End If

I don't get past line 1 without this error: "Type 'DeviceAPI.DeviceTypeInfo' is not defined"

Ideas?

[Wade]

I know so little about this that I should probably keep my mouth shut, but have you tried splitting it into:

Dim DT as DeviceAPI.DeviceTypeInfo
DT = Nothing

Or else use continuation:
Dim DT as DeviceAPI.DeviceTypeInfo : DT = Nothing


edit: nevermind--in my very limited experience I wasn't familiar with combining it as you did but with some googling see that what you've done should work.

[Wadenut]

I hadn't, as it shouldn't make a difference. It didn't. The problem seems to be that DeviceAPI.DeviceTypeInfo is undefined.
Probably something missing in that example, which really comes as no surprise.

[Wadenut]

It's possible too I'm going in the wrong direction.
Essentially, what I need to do is retrieve a list of valid CAPI controls for a given device. The example CAPI functions and their descriptions are no more helpful.

[enigmatheatre]

I have a need to access the device API in order to retrieve device type and control use information.

Starting with this example directly from the HS3 Online Help:

Example:

Retrieve the DeviceTypeInfo object:

Dim DT as DeviceAPI.DeviceTypeInfo = Nothing
dv = hs.GetDeviceByRef(1234)
DT = dv.DeviceType_Get(hs)
If DT IsNot Nothing Then
...
End If

I don't get past line 1 without this error: "Type 'DeviceAPI.DeviceTypeInfo' is not defined"

Ideas?

Try changing:

Dim DT as DeviceAPI.DeviceTypeInfo = Nothing

to

  Dim DT As DeviceTypeInfo = Nothing

Greig

[Wadenut]

Well, there we go! Thanks.
It would, as usual, be most helpful if the HS3 Help file were actually accurate. There's really no excuse.

Still, somehow I need to retrieve a list of CAPI controls for a given device. That section of the help is no more helpful.

[enigmatheatre]

Well, there we go! Thanks.
It would, as usual, be most helpful if the HS3 Help file were actually accurate. There's really no excuse.

Still, somehow I need to retrieve a list of CAPI controls for a given device. That section of the help is no more helpful.

This might help you.

    Sub Main()

        Dim strDevRef As Integer = 1234
        Dim objDev As Object
        Dim intDevRef As Integer
        Dim intCount As Integer

        hs.WriteLog("DevInfo", "Device : " & strDevRef)

        intDevRef = CInt(strDevRef)
        objDev = hs.GetDeviceByRef(intDevRef)
        If objDev Is Nothing Then
            hs.WriteLog("DevInfo", "Invalid device ref: " & strDevRef)
        Else
            hs.WriteLog("DevInfo", "Ref=" & strDevRef & "; Name=" & objDev.Name(hs) & "; Location=" & objDev.Location(hs) & "; Location2=" & objDev.Location2(hs) & "; Address=" & objDev.Address(hs))

            intCount = 0
            For Each objCAPIControl As CAPIControl In hs.CAPIGetControl(intDevRef)
                hs.WriteLog("DevInfo", ".CCIndex=" & CStr(objCAPIControl.CCIndex) & "; Label=" & CStr(objCAPIControl.Label) & "; ControlType=" & CStr(objCAPIControl.ControlType) & "; ControlValue=" & CStr(objCAPIControl.ControlValue) & "; ControlString=" & objCAPIControl.ControlString)
                intCount = intCount + 1
            Next
            If intCount = 0 Then
                hs.WriteLog("DevInfo", "No CAPIControl objects defined for this device")
            End If
        End If

    End Sub

[Wadenut]

That'll likely get what I need. I'll try a variation of it.
Essentially all I really need is to retrieve the control associated with a single given value.