Setuplinkkey method, Ildvxsco_tcp interface, Ildvxsco_tcp – Echelon OpenLDV User Manual
Page 186: Syntax, Returns

178
Custom Lookup Extension Component Programming
SetUplinkKey Method
Applies to: Session Control Object
This method sets the uplink lookup key. This unique key comes from the ASCII
RNI identifier passed to xDriver during an uplink session and is filled into the
SCO automatically. Therefore it is not required that you fill the uplink key into
the SCO.
Syntax
C++
STDMETHOD(SetUplinkKey)(BSTR upKey)
Visual Basic Sub SetUplinkKey(ByVal upKey As String)
Table 67. SetUplinkKey Parameters
Parameter
Description
upKey
Uplink lookup key of the RNI as a String (105 characters maximum).
Returns
Standard COM HRESULT describing the result of the call. Returns
E_ACCESS_DENIED if the field is currently read-only. Table 48 on page 166
lists each SCO field, along with when these fields are read-only.
ILdvxSCO_TCP Interface
The SCO_TCP interface is one of the interfaces to the Session Control Object. It
provides properties and methods used by user extensions to access and assign
values to the TCP-based fields of the xDriver Session Control Object.
This interface applies to the same object as the ILdvxSCO interface, and can be
accessed using standard COM techniques.
The methods included in this interface can be called from the UplinkLookup,
DownlinkLookup, and UpdateLookup methods. Table 68 lists the access
that the lookup extension component has to each SCO_TCP field from each of
these methods.
Table 68. SCO_TCP Fields
Field Name
Called From
DownlinkLookup UplinkLookup
UpdateLookup
Remote TCP Address
Read/Write
Read Only
Read Only
Remote TCP Port
Read/Write
Read Only
Read Only