Echelon OpenLDV User Manual download pdf (Page 174)

166 Custom Lookup Extension Component Programming

The ILdvxSCO interface provides methods that you can use to obtain the uplink

lookup key and fill in the SCO fields. For more information, see ILdvxSCO

Interface on page 166.

Syntax

C++ STDMETHOD(UplinkLookup)(ILdvxSCO * xSCO)

Visual Basic Sub UplinkLookup(ByVal xSCO As LdvxLib.ILdvxSCO)

Table 47. UplinkLookup Parameters

Parameter Description

xSCO Interface to the SCO object. This element contains the uplink key to

be looked up. The UplinkLookup implementation must fill in the

required SCO fields.

Returns

Standard xDriver LdvxResult (HRESULT) describing the result of the call. The

result is typically LDVX_S_OK (see LdvxResult). If the specified uplink key is

not recognized, the lookup extension component must return the error code

E_HANDLE, LDVX_E_INVALID_UPLINK_KEY, or

LDVX_E_LOOKUP_FAILURE.

ILdvxSCO Interface

The Session Control Object interface is one of the main interfaces to the xDriver

Session Control Object (SCO). It provides methods that are used by user

extensions to access and assign values to the common fields of the SCO. For a

description of these fields, see Session Control Object on page 108.

These methods are called from the UplinkLookup, DownlinkLookup, and

UpdateLookup methods. Table 48 lists the access that the lookup extension

component has to each SCO field from these methods.

Table 48. SCO Fields

Field Name

Called From

DownlinkLookup UplinkLookup UpdateLookup

Session Control Object ID Read Only Read Only Read Only

Authentication Flag Read/Write Read/Write Read Only

LNS Network Name Read/Write Read/Write Read Only

Downlink Key Read Only Read/Write Read Only

1 2 ... 169 170 171 172 173 174 175 176 177 178 179 ... 193 194

No comments

Echelon OpenLDV User Manual Page 174