Endsession, Endsystemmgmtmodechangeevent, Endsession m – Echelon OpenLNS User Manual

Page 898

Advertising
background image

OpenLNS Programmer's Reference

861

This event tag must be the one

returned by the

BeginServicePinEvent

method.

Added to API

Prior to LNS Release 3.0.

EndSession

Summary

Ends a session for methods and properties that must be

grouped to avoid intermediate error conditions.
All methods invoked and properties written between the

BeginSession

and

EndSession

methods are considered

atomic

. This method allows your application to create

connections more efficiently, and avoid failure scenarios that

can occur when devices or routers are moved or changed

one-by-one.
A given client can have at most one session in progress at a

time. A session must be part of an explicit transaction.

Availability

Local, full, and lightweight clients.

Syntax

systemObject.

EndSession

sessionClass

Element

Description

systemObject

The System

object to be acted on.

sessionClass

The session class.
Currently, the only valid value is

lcaSessionMove, which is

contained in the

ConstSessionClass

constant.

Added to API

Prior to LNS Release 3.0.

EndSystemMgmtModeChangeEvent

Summary

Disables the

OnSystemMgmtModeChangeEvent.

The

OnSystemMgmtModeChangeEvent

is fired every time

the system’s management mode changes. You can enable the

OnSystemMgmtModeChangeEvent

for your application by

invoking the

BeginSystemMgmtModeChangeEvent

method.

You can use the

MgmtMode

property to read or write to the

system management mode.

Availability

Local, full, and lightweight clients.

Syntax

system.EndSystemMgmtModeChangeEvent

Element

Description

systemObject

The System

object to be acted on.

Added to API

Prior to LNS Release 3.0.

Advertising