Getuplinkkey method, Setadditionaldownlinkpacketheader method, Syntax – Echelon OpenLDV User Manual

Page 180: Returns

Advertising
background image

172

Custom Lookup Extension Component Programming

GetUplinkKey Method

Applies to: Session Control Object
This method obtains the xDriver uplink lookup key. This key comes from the

RNI identifier that is passed to xDriver during an uplink session, and is filled

into the SCO automatically. It is the responsibility of the lookup extension

component to map this key to the authentication and LNS network parameters to

be used by the rest of the xDriver framework, and fill them into the SCO from the

UplinkLookup function.
For more information on the UplinkLookup function, see UplinkLookup on page

165.

Syntax

C++

STDMETHOD(GetUplinkKey)(BSTR * upKey)

Visual Basic Function GetUplinkKey() As String

Table 58. GetUplinkKey Parameters

Parameter

Description

upKey

Variable (String) that stores the return value.

Returns

The uplink lookup key of the RNI as a string.

SetAdditionalDownlinkPacketHeader Method

Applies to: Session Control Object
This method sets any additional bytes to pre-pend to the packet header sent

during a downlink session. Normally this field is an empty string (the default).

However, it can be used to specify a series of bytes that are pre-pended to every

packet used in a downlink session if there is an intermediate proxy between the

OpenLDV application and the RNI. These bytes can be used to provide routing

information the proxy might require.

Syntax

C++

STDMETHOD(SetAdditionalDownlinkPacketHeader)(BSTR hexBytes)

Visual Basic Sub SetAdditionalDownlinkPacketHeader(ByVal hexBytes As String)

Advertising