Setcurrentauthenticationkey method, Syntax, Returns – Echelon OpenLDV User Manual

Page 182

Advertising
background image

174

Custom Lookup Extension Component Programming

For more information about how the xDriver lookup extension component

handles authentication, see Authentication Key Handling on page 111.

Syntax

C++

STDMETHOD(SetAuthenticationFlag)(VARIANT_BOOL bAuth)

Visual Basic Sub SetAuthenticationFlag(ByVal bAuth As Boolean)

Table 61. SetAuthenticationFlag Parameters

Parameter

Description

bAuth

Authentication state as Boolean. If True, the xDriver

protocol engine generates and validates link-level authentication. If

False, the xDriver protocol engine neither generates nor validates

link-level authentication.
Always True for a SmartServer or i.LON 600.

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.

SetCurrentAuthenticationKey Method

Applies to: Session Control Object
This method sets the current xDriver authentication key. It is the responsibility

of the lookup extension component to map the downlink or uplink lookup key to

this authentication key, which is then used by xDriver to validate the connection.

The current authentication key must match the MD5 authentication key

configured into the RNI. For more information about how the lookup extension

component should handle authentication, see Authentication Key Handling on

page 111.
Setting an invalid current authentication key causes loss of contact with the RNI,

because an xDriver session cannot be started with an invalid authentication key.

Syntax

C++

STDMETHOD(SetCurrentAuthenticationKey)(BSTR authKey)

Visual Basic Sub SetCurrentAuthenticationKey(ByVal authKey As String)

Advertising