Echelon OpenLNS Manual de usuario

OpenLNS Programmer's Reference 078-0437-01A

OpenLNS Programmer’s Reference x DataValue ... 253

OpenLNS Programmer's Reference 63 be ORed with lcaConfigPropOptExcludeDeviceSpecific (64). Added to API Prior to LNS Release 3.0. Wink Summary

OpenLNS Programmer's Reference 963 3 Interfaces This chapter details each interface in the OpenLNS Object hierarchy.

OpenLNS Programmer's Reference 964 ILcaMsgMonitorPointListener The ILcaMsgMonitorPointListener interface can be added to a COM object created

OpenLNS Programmer's Reference 965 Syntax object.UpdateErrorEvent updateType Element Description object An object that implements the ILcaMsgMo

OpenLNS Programmer's Reference 966 request/response message. The OutputDp parameter's AutoWrite property is set to True; therefore, it wi

OpenLNS Programmer's Reference 967 instead of Windows messaging. You must call the Advise method from the event handler that is handling the u

OpenLNS Programmer's Reference 968 be set to 0. inputDp The DataPoint object containing the network variable monitor point update. The InputDp

OpenLNS Programmer's Reference 969 follow these steps: 1. Create an object that implements the ILcaProgressListener interface. 2. Define the

OpenLNS Programmer's Reference 970 The step name will be returned as a string of up to 128 characters. Added to API LNS Release 3.20.

OpenLNS Programmer's Reference 971 4 OpenLNS Errors This chapter lists and describes the errors that may be generated by the various OpenLNS c

OpenLNS Programmer's Reference 972 Errors LNS errors may be produced by each of the LNS components. These are uniquely identified in the objec

OpenLNS Programmer's Reference 64 • Handle • HasBeenCommissioned • IconFilePath • InitialAuthenticationKey • Interface • Interfaces •

OpenLNS Programmer's Reference 973 The device was discovered to be applicationless, or not associated with a program. If you encounter this err

OpenLNS Programmer's Reference 974 lcaErrNsNotImplemented 16 The specified service or option is not implemented by the specified server. Thi

OpenLNS Programmer's Reference 975 lcaErrNsUnsupportedInfo 28 The requested information is not available from an application node. For examp

OpenLNS Programmer's Reference 976 lcaErrNsObjectInUse 39 A requested operation can't complete because the object involved in the opera

OpenLNS Programmer's Reference 977 lcaErrNsProgramDblimit 55 This is an internal error, and should be reported to customer support. lcaErrNs

OpenLNS Programmer's Reference 978 lcaErrNsRouterNotFound 70 The specified router handle does not exist. lcaErrNsTimerRange 71 The timer

OpenLNS Programmer's Reference 979 other channel by repeaters or permanent bridges. Also, this error will occur if the channel is not currently

OpenLNS Programmer's Reference 980 lcaErrNsCpDbLimit 93 The configuration property database limit has been exceeded. lcaErrNsCpRangeNotFound

OpenLNS Programmer's Reference 981 The requested LonMark object member was not found. You will encounter this error if you try to use the Unass

OpenLNS Programmer's Reference 982 lcaErrNsNvNotLmobjMember 122 The network variable is not a member of a LonMark object. lcaErrNsHostResour

OpenLNS Programmer's Reference 65 Read/Write Read only. Added to API LNS Release 3.20. AliasUseCount Summary Returns the number of network var

OpenLNS Programmer's Reference 983 lcaErrNsNsiInuse 136 Returned when an attempt is made to remove an NSI that is being used by other proces

OpenLNS Programmer's Reference 984 Note that you must stop the "CrypkeyLicense" service and "NetworkX" driver before deleti

OpenLNS Programmer's Reference 985 lcaErrNsMaxDbOpened 158 Exceeded the maximum number of databases lcaErrNsEventsNotInitialized 159 E

OpenLNS Programmer's Reference 986 An OpenLNS network interface uses an IP address not defined on this PC. lcaErrNsNsiNotConfigured 176 NSI

OpenLNS Programmer's Reference 987 However, the device will remain applicationless. You should load a new application image into the device wi

OpenLNS Programmer's Reference 988 Resource count exceeds capacity limits in self-identification data. lcaErrNsLmsdObjectRange 267 Invalid o

OpenLNS Programmer's Reference 989 lcaErrNsCpsdTemplateVersion 279 The version of the CP template is unsupported. lcaErrNsGroupDblimit 28

OpenLNS Programmer's Reference 990 The bound network variables must be disconnected before the LonMarkObject can be deleted. You can disconnect

OpenLNS Programmer's Reference 991 the device template was imported from an external interface file, the configuration property template file c

OpenLNS Programmer's Reference 992 persistent update failures on a device, you should re-commission the device with the Commission method. lcaE

OpenLNS Programmer's Reference 66 DeviceTemplate object's XifPath property. If this application device was not created from a device temp

OpenLNS Programmer's Reference 993 lcaErrNsUpdateCpFailure 4038 The database updates were successful, but the configuration properties on on

OpenLNS Programmer's Reference 994 Could not communicate with the network interface. A message timed out. lcaErrNiUplinkCmd 9 An uplink

OpenLNS Programmer's Reference 995 May not send implicit tags via NI layer. Must use a message monitor point. lcaErrNiUnimplemented 27 Th

OpenLNS Programmer's Reference 996 Connection Errors Connection errors are errors returned when attempting to make network variable or message

OpenLNS Programmer's Reference 997 If the connection members are not SNVTs, then all members must have the same length. lcaErrConnDirectionOrP

OpenLNS Programmer's Reference 998 shared by connections that intersect each other. This error will be generated when an attempt is made to for

OpenLNS Programmer's Reference 999 A network can use up to 12288 selector values. Unrelated connections will normally require unique selector v

OpenLNS Programmer's Reference 1000 network variable may be received by connections and devices that it is not intended to. LNS attempts to avo

OpenLNS Programmer's Reference 1001 identical. If a polling input network variable is a member of multiple connections, the timer settings for

OpenLNS Programmer's Reference 1002 lcaErrUninitializedDb 5 Contact technical support. lcaErrObjectNotFound 6 An object has been requeste

OpenLNS Programmer's Reference 67 object’s AuthenticationKey property. 2. Set the AuthenticationEnabled property of the AppDevice object that

OpenLNS Programmer's Reference 1003 Alternatively, the XFB file might be re-build from the XIF file, using the XIF32BIN.EXE utility. lcaErrInva

OpenLNS Programmer's Reference 1004 lcaErrDatabase 25 An unexpected database error occurred. Please take a note of the full error message, a

OpenLNS Programmer's Reference 1005 Contact customer support. lcaErrCompiler 41 Generic compiler error. See the LNS Field Compiler documenta

OpenLNS Programmer's Reference 1006 lcaErrCantCopyNssDirectory 54 Internal error. Contact customer support. lcaErrCantRecoverNotNewDb 55

OpenLNS Programmer's Reference 1007 lcaErrAnotherNetworkAlreadyOpen 66 An attempt to open a network database failed because another network

OpenLNS Programmer's Reference 1008 lcaErrCantLaunchLcaServer 79 The OpenLNS Server cannot be launched. lcaErrNoMemory 80 No more system

OpenLNS Programmer's Reference 1009 removing items at runtime. It should be noted that this exception may also occur with collections which are

OpenLNS Programmer's Reference 1010 lcaNeuronIdInUse 102 The NEURON ID assigned is already in use for another device in the network. lcaDbC

OpenLNS Programmer's Reference 1011 A service which is only available local to the server or on a Full client has been requested from a Lightwe

OpenLNS Programmer's Reference 1012 A network variable name is required for this service. LcaInternalErrBadExceptionCode 133 Internal error.

OpenLNS Programmer's Reference 68 be installed in the device or router side by some external means. Setting this property to False results in r

OpenLNS Programmer's Reference 1013 The extension record is too large to be accessed remotely. Data Server Errors These are errors returned by

OpenLNS Programmer's Reference 1014 The operation specified was canceled interactively at the user interface. lcaErrDsVersionIncompatibility

OpenLNS Programmer's Reference 1015 A Network Services call to get type information for this network variable has failed. lcaErrDsStartNvObject

OpenLNS Programmer's Reference 1016 lcaErrDsObjectIsAlreadyStarted 49 Cannot start this object, as it is already started. lcaErrDsSetInvalid

OpenLNS Programmer's Reference 1017 lcaErrDsFmttypeHasNoFields 67 The format type specified does not contain information about fields. lca

OpenLNS Programmer's Reference 1018 lcaErrLnsDsNotImpl 368 Not implemented. lcaErrLnsDsPointer 369 Invalid pointer. lcaErrLnsDsIn

OpenLNS Programmer's Reference 1019 Object not found. lcaErrLnsDsClientNotFound 385 Client not found. lcaErrLnsDsNetworkNotFound 386 Ne

OpenLNS Programmer's Reference 1020 lcaErrLnsDsVniCloseFailed 402 There was an error closing the VNI. lcaErrLnsDsThreadCreateFailed 403

OpenLNS Programmer's Reference 1021 lcaErrLnsDsInvalidClientContext 420 Invalid or no client context was supplied. lcaErrLnsDsImplicitAddres

OpenLNS Programmer's Reference 1022 lcaErrFormatInvalidTypFile 5 Invalid type file. lcaErrFormatReferenceEnumScopeNotFound 6

OpenLNS Programmer's Reference 69 AppDevices collection. Availability Local, full, and lightweight clients. Syntax channelObject = object.Chan

OpenLNS Programmer's Reference 1023 lcaErrFormatNotBuiltInSpec 23 Not built in spec. lcaErrFormatInvalidPropSet

OpenLNS Programmer's Reference 1024 Duplicate string provided. This exception will be thrown if you write to the CategoryPreferenceList proper

OpenLNS Programmer's Reference 1025 LDRF error: full. lcaErrFormatLdrfErrDuplicate 216 LDRF error: duplicate. lcaErrFormatLdrfErrN

OpenLNS Programmer's Reference 1026 Remote object does not exist. lcaErrRmoNoIpcMsgAvail 5 No Windows Inter Process Communication (

OpenLNS Programmer's Reference 1027 LonTalk Adapter name too long. lcaErrLtaInvalidState 309 LonTalk Adapter invalid state. lca

OpenLNS Programmer's Reference 1028 LonTalk Adapter error log mask. lcaErrLtaNvLengthMismatch 430 LonTalk Adapter network variable le

OpenLNS Programmer's Reference 1029 Out of memory (registry subsystem). lcaErrVniRegCantFindObject 604 Cannot find object (reg

OpenLNS Programmer's Reference 1030 Message monitor point not found. lcaErrVniMustSpecifyMsgTag 622 Must specify message tag.

OpenLNS Programmer's Reference 1031 Configuration file could not be found. lcaErrVniRegCannotUpdateConfigFile 640 Configuration file c

OpenLNS Programmer's Reference 1032

OpenLNS Programmer's Reference 70 commissioning, and lcaCommissionUpdatesCurrent (0) after a successful commission. This property will be set t

OpenLNS Programmer's Reference 1033 Appendix A Deprecated Items This appendix lists methods, properties, and objects that should no longer be u

OpenLNS Programmer's Reference 1034 Deprecated Items In OpenLNS and LNS Turbo Editions, some methods, objects, properties and events have been

LNS FX Programmer's Reference 1035 Deprecated Objects The following objects have been deprecated in OpenLNS and LNS Turno Editions (3.2). This

OpenLNS Programmer's Reference 1036 Deprecated Methods The following methods have been deprecated in OpenLNS and LNS Turbo Editions (3.2). This

OpenLNS Programmer's Reference 1037 Method Applicable Parent Object Version Reason Substitute Feature OpenComponent AppDevice 3.2 U Pur

OpenLNS Programmer's Reference 1038 Deprecated Properties The following propeties have been deprecated in OpenLNS and LNS Turbo Editions (3.2).

OpenLNS Programmer's Reference 1039 Property Applicable Parent Object Version Reason Substitute Feature DataServerObjectHandle System 3.

OpenLNS Programmer's Reference 1040 Property Applicable Parent Object Version Reason Substitute Feature when displaying network variable va

OpenLNS Programmer's Reference 1041 Property Applicable Parent Object Version Reason Substitute Feature DsService NetworkVariable Networ

OpenLNS Programmer's Reference 1042 Property Applicable Parent Object Version Reason Substitute Feature MaxDefecitCredits CreditInfo 4.0 NL

OpenLNS Programmer's Reference 71 changes. 2 lcaCommissionUpdatesFailed Commission updates are currently pending or in progress, and the most

OpenLNS Programmer's Reference 1043 Property Applicable Parent Object Version Reason Substitute Feature ValueFromDevice ConfigProperty

www.echelon.com

OpenLNS Programmer's Reference 72 ConnectionUpdateType Summary Specifies in which state the AppDevice is placed while performing a connection u

OpenLNS Programmer’s Reference xi RegisteredComponent ... 282 SelfDocConsistency ...

OpenLNS Programmer's Reference 73 Read/Write Read/write. Added to API Prior to LNS Release 3.0. Delay Summary Represents the average number of

OpenLNS Programmer's Reference 74 Added to API This depends on the object used to access the property. Generally, this property exists for the

OpenLNS Programmer's Reference 75 identifier set by the manufacturer Availability Local, full, lightweight, and independent clients. Syntax ext

OpenLNS Programmer's Reference 76 whether all database changes have been propagated to the physical device. Availability Local, full, and light

OpenLNS Programmer's Reference 77 its authentication key because the device has authentication enabled. If the InitialAuthenticationKey is set

OpenLNS Programmer's Reference 78 and custom interfaces associated with the device. The Interfaces collection allows virtual and custom interfa

OpenLNS Programmer's Reference 79 monitor set, and monitor point) during the upgrade. If you have not called the Upgrade method on a device and

OpenLNS Programmer's Reference 80 appDevObject.LocationinNeuron = locationValue Element Description locationValue The location as read from th

OpenLNS Programmer's Reference 81 Added to API LNS Release 3.0. Name Summary Specifies the name of an object as a character string. This proper

OpenLNS Programmer's Reference 82 Availability Local, full, and lightweight clients. Syntax neuronIdValue = object.NeuronId Element Descripti

OpenLNS Programmer’s Reference xii Item ... 312 Parent

OpenLNS Programmer's Reference 83 NonGroupRcvTimerNonGroupRcvTimer_Property Summary The value of the device's non-group receive timer. Th

OpenLNS Programmer's Reference 84 Syntax handleValue = nsdObject.NsiHandle Element Description handleValue The NSI’s handle. nsdObject The Netw

OpenLNS Programmer's Reference 85 object Any object for which the parent is desired. Data Type Object. Read/Write Read only. Added to API Dep

OpenLNS Programmer's Reference 86 System object's PingIntervals property. Data Type Integer. Read/Write Read/write. Added to API Prior t

OpenLNS Programmer's Reference 87 127 lcaLNSNodePriorityMax Represents the maximum number of priority slots on any LonTalk channel. Do not se

OpenLNS Programmer's Reference 88 Availability Local, full, and lightweight clients. Syntax descriptionString = object.SelfDocumentation Eleme

OpenLNS Programmer's Reference 89 properties are read-only. 2 lcaStateUncnfg The application is loaded but the configuration is either not l

OpenLNS Programmer's Reference 90 mode). The device's service LED is off in this state. object The device to be acted on. Data Type Inte

OpenLNS Programmer's Reference 91 Subsystems Summary Contains the Subsystem collection object associated with the specified AppDevice. A Subsy

OpenLNS Programmer's Reference 92 Syntax upgradeReqValue = adObject.UpgradeRequirement Element Description upgradeReqValue An enumerated value

OpenLNS Programmer’s Reference xiii ClassId ... 357 Count .

OpenLNS Programmer's Reference 93 Methods The AppDevices object contains the following methods. • Add • AddReference • ItemByHandle • ItemB

OpenLNS Programmer's Reference 94 • The device’s network variables and message tags are unbound; • The device’s priority slot is set to zero

OpenLNS Programmer's Reference 95 commissioned. You should specify the channel whenever possible. channelObject The Channel object of the chann

OpenLNS Programmer's Reference 96 Element Description collection The AppDevices collection to gain the reference. object The AppDevice object t

OpenLNS Programmer's Reference 97 If the application device in not a member of any other subsystem, then the application device is completely r

OpenLNS Programmer's Reference 98 object The object to be acted on. Data Type Integer. Read/Write Read only. Added to API Depends on the obje

OpenLNS Programmer's Reference 99 stringExpression A string type specifying the name of the object to retrieve. Data Type Object. Read/Write

OpenLNS Programmer's Reference 100 Availability Local, full, and lightweight clients. Syntax retrievedObject = collObject._NewEnum Element Desc

OpenLNS Programmer's Reference 101 ClassId Summary Identifies the object class of this object. Availability Local, full, lightweight, and inde

OpenLNS Programmer's Reference 102 Syntax majVersion = appObject.MajorVersion Element Description majVersion The major version number of this a

OpenLNS Programmer’s Reference xiv Item ... 400 Parent

OpenLNS Programmer's Reference 103 Availability Local, full, lightweight, and independent clients. Note that some objects that contain this pro

OpenLNS Programmer's Reference 104 ConstApplicationState constant, are as follows: 0 LcaApplOnline The application is currently executing. 1

OpenLNS Programmer's Reference 105 Default Property None. Methods None. Properties • ClassId • InputBufferCount • InputBufferSize • Outp

OpenLNS Programmer's Reference 106 InputBufferCount Summary Contains the value of the input buffer count used for router configuration. Change

OpenLNS Programmer's Reference 107 Data Type Long. Read/Write Read/write. Added to API Prior to LNS Release 3.0. OutputBufferCount Summary Co

OpenLNS Programmer's Reference 108 Element Description bufSize The output buffer size. bcObject The BufferConfiguration object to be acted on.

OpenLNS Programmer's Reference 109 for more information. Availability Local, full, and lightweight clients. Syntax bufSize = bcObject.PriorityB

OpenLNS Programmer's Reference 110 Properties The Channel object contains the following properties: • AltPathType • AppDevices • BitmapFile

OpenLNS Programmer's Reference 111 1 lcaChannelAltPathNotRequired This channel does not require use of the alternate path. This value should

OpenLNS Programmer's Reference 112 Syntax bmpFilePath = object.BitmapFilePath Element Description bmpFilePath The bitmap path and file name. o

OpenLNS Programmer’s Reference xv ParentInterface ... 432 PrincipalNv ..

OpenLNS Programmer's Reference 113 size and channel transceiver type. When you write to this property, you should note that the delays for tran

OpenLNS Programmer's Reference 114 manufacturers. Each object is identified with a unique identifier set by the manufacturer Availability Loca

OpenLNS Programmer's Reference 115 object The object to be acted on. Data Type String. Read/Write Read/write. If you write to this property,

OpenLNS Programmer's Reference 116 Availability Local, full, lightweight, and independent clients. Note that some objects that contain this pro

OpenLNS Programmer's Reference 117 routersCollection The Routers collection returned. Data Type Routers collection object. Read/Write Read onl

OpenLNS Programmer's Reference 118 transceiver. 11 lcaXcvrTP_RS485_1250 TP/RS485-1250 LonWork transceiver. 12 lcaXcvrTP_RS485_78 TP/RS-485-78

OpenLNS Programmer's Reference 119 29 lcaXcvrDC_1250 DC-1250 LONWORKS transceiver. channelObject Channel object to be acted upon. Data Type L

OpenLNS Programmer's Reference 120 Element Description channelObject The newly defined channel object. channelsObject The Channels collection o

OpenLNS Programmer's Reference 121 CENELEC A-band. 16 lcaXcvrPL_20C PLT-20, PLT-21, and PLT-22 LONWORKS transceivers using CENELEC C-band. 17

OpenLNS Programmer's Reference 122 Remove Summary Removes a channel from the network. A channel may only be removed if there are no devices or

OpenLNS Programmer’s Reference xvi Enable... 467 Open ...

OpenLNS Programmer's Reference 123 added to the API. Comments This property allows the object type to be determined when it is unknown (for ex

OpenLNS Programmer's Reference 124 Syntax filterValue = channelsCollection.FilterType Element Description filterValue The active filter type. T

OpenLNS Programmer's Reference 125 collObject The Channels collection object to be acted on. index A Long type specifying the ordinal index of

OpenLNS Programmer's Reference 126 • If the FilterType property is set to lcaChannelFilterPath, the Channels collection object will access all

OpenLNS Programmer's Reference 127 set to lcaChannelFilterTransceiver. When this is the case, the Channels collection object will access the C

OpenLNS Programmer's Reference 128 ComponentApp This object describes a LONWORKS plug-in command. ComponentApps collection objects are contain

OpenLNS Programmer's Reference 129 ClassId Summary Identifies the object class of this object. Availability Local, full, lightweight, and inde

OpenLNS Programmer's Reference 130 1 lcaCommandIdNew 2 lcaCommandIdEditSource 10 lcaCommandIdBuildImage 11 lcaCommandIdCommission 12 lca

OpenLNS Programmer's Reference 131 6 lcaClassIdSubsystems 7 lcaClassIdAppDevice 8 lcaClassIdAppDevices 9 lcaClassIdRouter 10 lcaClassI

OpenLNS Programmer's Reference 132 59 lcaClassIdAliases 69 lcaClassIdPingIntervals 70 lcaClassIdApplication 71 lcaClassIdTestInfo 72 lcaCl

OpenLNS Programmer’s Reference xvii UpdateErrorEvent ... 505 UpdateEvent ...

OpenLNS Programmer's Reference 133 implements the default action compAppObject The ComponentApp object to be acted on. Data Type Boolean. Rea

OpenLNS Programmer's Reference 134 Name Summary Specifies the name of a ComponentApp object as a character string. This property is case sensit

OpenLNS Programmer's Reference 135 RegisteredServer Summary Contains the plug-in name that is stored in the Windows registry for this component

OpenLNS Programmer's Reference 136 Note that the Interface property of all AppDevice objects contain a ComponentApps collection; however, the b

OpenLNS Programmer's Reference 137 the ComponentApp object for the possible values. Added to API Prior to LNS Release 3.0. Remove Summary Rem

OpenLNS Programmer's Reference 138 Added to API Depends on the object used to access the property. Generally, this property exists for an objec

OpenLNS Programmer's Reference 139 Data Type Object. Read/Write Read only. Added to API Depends on the object used to access the property. Gen

OpenLNS Programmer's Reference 140 Syntax retrievedObject = collObject._NewEnum Element Description retrievedObject An expression that evaluate

OpenLNS Programmer's Reference 141 handle A Long value specifying the handle of the ConfigProperty object to be retrieved. Added to API LNS R

OpenLNS Programmer's Reference 142 Syntax returnValue = object.Count Element Description returnValue The number of objects in the collection as

OpenLNS Programmer’s Reference xviii Parent ... 543 _NewEn

OpenLNS Programmer's Reference 143 Parent Summary Returns the object that spawned the current child object. Availability Local, full, lightwei

OpenLNS Programmer's Reference 144 Data Type Object. Read/Write Read only. Added to API OpenLNS. ConfigProperty A ConfigProperty object repres

OpenLNS Programmer's Reference 145 Methods The ConfigProperties object contains the following methods: • GetDataPoint • GetRawValuesEx •

OpenLNS Programmer's Reference 146 The value of the ConfigProperty will be updated in the OpenLNS database and in the physical device each time

OpenLNS Programmer's Reference 147 value is recommended only when updating the database with a value that has just been read from the device. F

OpenLNS Programmer's Reference 148 retrieved. If you specify an invalid index, an LCA, #90 lcaValueOutOfRange exception is thrown. count Spec

OpenLNS Programmer's Reference 149 Added to API LNS Release 3.20. SetRawValuesEx Summary Sets the raw value for a range of elements in an array

OpenLNS Programmer's Reference 150 just been read from the device (for example, create a data point with the lcaDataSourceOptionsFromDevice (1

OpenLNS Programmer's Reference 151 • ConstantAttribute • Description • DeviceSpecificAttribute • Dimension • FlagsByte • FormatN

OpenLNS Programmer's Reference 152 AppDevice or DeviceTemplate as a whole, a collection of LonMarkObjects, or a collection of NetworkVariable o

OpenLNS Programmer’s Reference xix Properties ... 570 Cla

OpenLNS Programmer's Reference 153 ByteLength Summary Returns the length (in bytes) of a single configuration property element. Multiplying th

OpenLNS Programmer's Reference 154 added to the API. Comments This property allows the object type to be determined when it is unknown (for ex

OpenLNS Programmer's Reference 155 Read/Write Read only. Added to API OpenLNS. ConfigFileType Summary Specifies the type of configuration value

OpenLNS Programmer's Reference 156 Syntax fileType = cpObject.ConfigFileType Element Description fileType The type of the configuration value f

OpenLNS Programmer's Reference 157 implemented by an array of network variables, array elements will be implemented by consecutive network vari

OpenLNS Programmer's Reference 158 by an array of network variables, the array elements will be implemented by consecutive network variables.

OpenLNS Programmer's Reference 159 organization at the time. As a result, LNS 3.20 allows applications such as device plug-ins to modify the c

OpenLNS Programmer's Reference 160 Description Summary Stores description information about the ConfigProperty object. Availability Local, f

OpenLNS Programmer's Reference 161 installation. Therefore, you can modify the device-specific attribute by writing to this property. Set this

OpenLNS Programmer's Reference 162 Dimension Summary Returns the length (in bytes) of a single configuration property element. Multiplying thi

ii Echelon, LON, LonWorks, Neuron, 3120, 3150, i.LON, LNS, LonMaker, LONMARK, LonTalk, NodeBuilder, and the Echelon logo are trademarks of Echelon Co

OpenLNS Programmer’s Reference xx Priority ... 610 Priorit

OpenLNS Programmer's Reference 163 The configuration property is offline. 4 lcaCpFlagsConstant The configuration property has the constant at

OpenLNS Programmer's Reference 164 a SNVT_xxx type, it will be formatted as specified by the format file. 2. If the ConfigProperty object’s ty

OpenLNS Programmer's Reference 165 that has the same name as the underlying type. This is called the root format for the type, and may be diffe

OpenLNS Programmer's Reference 166 Data Type String. Read/Write Read/write. Added to API Prior to LNS Release 3.0. FuncProfileDescription Sum

OpenLNS Programmer's Reference 167 Read/Write Read-only. Added to API Prior to LNS Release 3.0. FuncProfileProgrammaticName Summary Returns th

OpenLNS Programmer's Reference 168 Once the implementation type is known, a client can retrieve the appropriate addressing information for the

OpenLNS Programmer's Reference 169 Added to API OpenLNS. Mode Summary Returns the scope of the LonMark resource file containing the definition

OpenLNS Programmer's Reference 170 subclass and model. -1 lcaResourceScopeUnknown The scope of the resource file is not known, or could not b

OpenLNS Programmer's Reference 171 Data Type Object. Read/Write Read only. Added to API Depends on the object used to access the property. Gene

OpenLNS Programmer's Reference 172 account for changes to the configuration property’s type. Only configuration properties that apply to networ

OpenLNS Programmer’s Reference xxi Events ... 653 Up

OpenLNS Programmer's Reference 173 ValueStatus Summary Determines the current state of the value stored in the OpenLNS database for the ConfigP

OpenLNS Programmer's Reference 174 OpenLNS database by calling the UploadConfigProperties method, and specifying lcaConfigPropOptLoadUnknown (4

OpenLNS Programmer's Reference 175 Description A generic connection description template that can be applied to multiple network variable conne

OpenLNS Programmer's Reference 176 • UsePriorityFlag AliasOptions Summary Specifies how network variable aliases should be used in the connect

OpenLNS Programmer's Reference 177 the ConstConnBroadcastOptions constant, are as follows: 0 lcaBroadcastNever No broadcast addressing will b

OpenLNS Programmer's Reference 178 is unknown (for example, when the object was accessed using the Parent property of another object). Descript

OpenLNS Programmer's Reference 179 the list of hubs; therefore, you should update the cached copy of the complete hub list when you add or dele

OpenLNS Programmer's Reference 180 Syntax nvColl = cdtObject.NVHubs Element Description cdtObject The ConnectDescTemplate object to be acted o

OpenLNS Programmer's Reference 181 Syntax propOptionsValue = cdtObject.PropertyOptions Element Description cdtObject The ConnectDescTemplate

OpenLNS Programmer's Reference 182 RepeatCount property of the ConnectDescTemplate object. 32 lcaConnPropsRepeatTimer Select this value to act

OpenLNS Programmer’s Reference xxii Object ... 685 Parent

OpenLNS Programmer's Reference 183 default receive timer is calculated based on the network topology, channel delays, and other connections tha

OpenLNS Programmer's Reference 184 Syntax repeatCountValue= cdtObject.RepeatCount Element Description cdtObject The ConnectDescTemplate object

OpenLNS Programmer's Reference 185 repeatTimerValue The encoded value of the repeat timer. The default value for this property is determined

OpenLNS Programmer's Reference 186 RetryCount Summary Sets the maximum number of times to resend messages sent with the request/response, unack

OpenLNS Programmer's Reference 187 ServiceType Summary Stores the messaging service to be used for the connection. Note: This property will on

OpenLNS Programmer's Reference 188 acknowledgment messages. Do not use this service type on channels that support altnerate frequencies becaus

OpenLNS Programmer's Reference 189 1 0.024 2 0.032 3 0.048 4 0.064 5 0.096 6 0.128 7 0.192 8 0.256 9 0.384 10 0.512 11 0.768 12 1.024 13 1.536

OpenLNS Programmer's Reference 190 AuthenticationFlag. This property is used for network variable connections only. Data Type Boolean. Read/Wr

OpenLNS Programmer's Reference 191 ConnectDescTemplates A ConnectDescTemplates object is a collection of ConnectDescTemplate objects. The inst

OpenLNS Programmer's Reference 192 ItemByHandle Summary Retrieves a ConnectDescTemplate object, specified by its handle, from a ConnectDescTemp

OpenLNS Programmer’s Reference xxiii InOverride ... 737 InvalidI

OpenLNS Programmer's Reference 193 Independent clients. Syntax classIdValue = object.ClassId Element Description classIdValue The object class

OpenLNS Programmer's Reference 194 passing the object’s name as a string expression Availability Local, full, lightweight, and independent clie

OpenLNS Programmer's Reference 195 For Each ... Next statements. • If you are developing your OpenLNS app in Visual C++, you can browse a coll

OpenLNS Programmer's Reference 196 Methods The Connections object does not contain any methods. Properties The Connections object contains the

OpenLNS Programmer's Reference 197 Data Type MessageTags collection object. Read/Write Read only. Added to API Prior to LNS Release 3.0. Netw

OpenLNS Programmer's Reference 198 CreditInfo OpenLNS applications can determine a system’s current licensing status by reading the properties

OpenLNS Programmer's Reference 199 Syntax classIdValue = object.ClassId Element Description classIdValue The object class of the object. The f

OpenLNS Programmer's Reference 200 always 0. creditObject The CreditInfo object to be acted on. Data Type Long. Read/Write Read only. Added t

OpenLNS Programmer's Reference 201 MaxDeficitCredits (Deprecated) Summary Returns 0. Note: In previous LNS releases, this property indicted th

OpenLNS Programmer's Reference 202 All the other properties contain information describing the errors that were discovered in the database duri

OpenLNS Programmer’s Reference xxiv ReplaceEx ... 773 Reset ...

OpenLNS Programmer's Reference 203 filename to where the file is to be exported. This must be a valid system path overwriteExisting This elemen

OpenLNS Programmer's Reference 204 Data Type Integer. Read/Write Read only. Added to API Depends on the object used to access the property. Ge

OpenLNS Programmer's Reference 205 Read/Write Read only. Added to API Depends on the object used to access the property. Generally, this proper

OpenLNS Programmer's Reference 206 Syntax repairedCount = validationReport.RepairedErrors Element Description repairedCount The number of err

OpenLNS Programmer's Reference 207 UnrepairedErrors Summary Contains the number of errors discovered during the database validation that were n

OpenLNS Programmer's Reference 208 Description Indicates whether OpenLNS was able to repair a specific error during a database validation. Adde

OpenLNS Programmer's Reference 209 Syntax classIdValue = object.ClassId Element Description classIdValue The object class of the object. The f

OpenLNS Programmer's Reference 210 A duplicate dynamic network variable was found on a device’s interface. 3 lcaDbValidationError MissingNV A

OpenLNS Programmer's Reference 211 discovered. This is an internal error. 13 lcaDbValidationErrorDuplicateDynamicLMO Duplicate LonMark object d

OpenLNS Programmer's Reference 212 Integrity This is an internal error. 132 lcaDbValidationErrorNssLink Integrity This is an internal error.

OpenLNS Programmer’s Reference xxv Methods ... 812 Prop

OpenLNS Programmer's Reference 213 ObjectInternalId Summary Indicates the internal ID of the object that caused the error, which is referenced

OpenLNS Programmer's Reference 214 Parent Summary Returns the object that spawned the current child object. The parent object is determined by

OpenLNS Programmer's Reference 215 ParentObjectClass Summary Indicates the class ID of the parent of the object that caused the error, which is

OpenLNS Programmer's Reference 216 ParentObjectInternalId Summary Indicates the internal ID of the parent of the object that caused the error,

OpenLNS Programmer's Reference 217 ParentObjectName Summary Indicates the name of the parent of the object that caused the error, which is refe

OpenLNS Programmer's Reference 218 Syntax isRepairable = validationObject.Repairable Element Description validationObject The DatabaseValidat

OpenLNS Programmer's Reference 219 RepairAttempted Summary Indicates whether OpenLNS attempted to repair errors of this type during the validat

OpenLNS Programmer's Reference 220 Syntax repaired = errorReport.Repairable Element Description errorReport The DatabaseValidationErrorInstan

OpenLNS Programmer's Reference 221 index number. The index number will be in the range of 1 to x, where x represents the value stored in the Co

OpenLNS Programmer's Reference 222 Data Type Integer. Read/Write Read only. Added to API Depends on the object used to access the property. Ge

OpenLNS Programmer’s Reference xxvi Remove ... 838 Properties

OpenLNS Programmer's Reference 223 Read/Write Read only. Added to API Depends on the object used to access the property. Generally, this proper

OpenLNS Programmer's Reference 224 Syntax retrievedObject = collObject._NewEnum Element Description retrievedObject An expression that evaluate

OpenLNS Programmer's Reference 225 ObjectDetailsAvailable property. If you specify an invalid number as the index element when invoking this me

OpenLNS Programmer's Reference 226 Element Description classIdValue The object class of the object. The following value is defined for the Dat

OpenLNS Programmer's Reference 227 2 lcaDbValidationError DuplicateDynamicNV A duplicate dynamic network variable was found on a device’s int

OpenLNS Programmer's Reference 228 12 lcaDbValidationErrorDuplicateDynamicMT Duplicate dynamic message tag data was discovered. This is an in

OpenLNS Programmer's Reference 229 This is an internal error. 129 lcaDbValidationError NssUniqueKeyIntegrity This is an internal error. 130 lca

OpenLNS Programmer's Reference 230 ObjectDetailsAvailable Summary Indicates whether you can retrieve specific information about each instance o

OpenLNS Programmer's Reference 231 Data Type Object. Read/Write Read only. Added to API Depends on the object used to access the property. Gene

OpenLNS Programmer's Reference 232 RepairAttempted Summary Indicates whether OpenLNS attempted to repair errors of this type during the validat

OpenLNS Programmer’s Reference xxvii ClientId... 877 Commis

OpenLNS Programmer's Reference 233 the network device containing the source object) by default. You can change this behavior by setting the Aut

OpenLNS Programmer's Reference 234 • Write GetField Summary Gets a DataPoint object containing one field if the DataPoint object contains a st

OpenLNS Programmer's Reference 235 Syntax dpObject.Read Element Description dpObject The DataPoint object being acted upon. Added to API LNS

OpenLNS Programmer's Reference 236 • AutoWrite • ClassId • FieldCount • FieldName • FormatSpec • FormattedValue • MaxValue • Mess

OpenLNS Programmer's Reference 237 method). Data Type Boolean. Read/Write Read/write. Added to API LNS Release 3.0. AutoWrite Summary Determ

OpenLNS Programmer's Reference 238 ClassId Summary Identifies the object class of this object. This property allows the object type to be dete

OpenLNS Programmer's Reference 239 FieldName Summary Indicates the name of the field if the DataPoint object contains multiple fields. If a D

OpenLNS Programmer's Reference 240 FormatSpec Summary Contains the format specification information for data read from the FormattedValue prope

OpenLNS Programmer's Reference 241 FormattedValue Summary Contains the value of the data point as a Variant. To read the value of a data point’

OpenLNS Programmer's Reference 242 Formatter#16 lcaErrFormatIllegalDataOnUnformat exception will be thrown. You should note that OpenLNS only p

OpenLNS Programmer’s Reference xxviii ClassId ... 916 Count

OpenLNS Programmer's Reference 243 MaxValue Summary Contains the maximum value that can be applied to the FormattedValue property of the DataPo

OpenLNS Programmer's Reference 244 Availability Local, full, lightweight, and independent clients. Note that some collection objects are not av

OpenLNS Programmer's Reference 245 MinValue Summary Contains the minimum value that can be applied to the FormattedValue property of the DataPo

OpenLNS Programmer's Reference 246 Availability Local, full, lightweight, and independent clients. Note that some collection objects are not av

OpenLNS Programmer's Reference 247 RawValue Summary Contains the value of the DataPoint as a raw byte array. To read the value of the data poi

OpenLNS Programmer's Reference 248 to avoid passing invalid data to data point. Availability Local, full, lightweight, and independent clients.

OpenLNS Programmer's Reference 249 Data Type Integer. Read/Write Read/write. Added to API LNS Release 3.20. SourceOptions Summary You can use

OpenLNS Programmer's Reference 250 device-specific, the value will be read from the database, as long as it is stored there. If its value does

OpenLNS Programmer's Reference 251 thrown. 3 lcaDataSourceOptionsTypeDefaultValue The data point value is set to the default value of configu

OpenLNS Programmer's Reference 252 To read the value of the data point’s source object (the value of the source object in the OpenLNS database

OpenLNS Programmer’s Reference xxix ToOwnerIndex ... 953 UpgradeInfos .

OpenLNS Programmer's Reference 253 turn off this attribute using OpenLNS. You can use the MinValue and MaxValue properties to set the minimum a

OpenLNS Programmer's Reference 254 Properties The DataValue object contains the following properties: • AppDevice • ClassId • Data • Dat

OpenLNS Programmer's Reference 255 Syntax classIdValue = object.ClassId Element Description classIdValue The object class of the object. The f

OpenLNS Programmer's Reference 256 Length Summary INTERNAL USE ONLY Data Type Integer. Read/Write Read only. Added to API Prior to LNS Release

OpenLNS Programmer's Reference 257 SourceNodeId Summary Indicates the node ID of the device making a network variable update to a host network

OpenLNS Programmer's Reference 258 SourceSubnetId Summary Indicates the subnet ID of the device making a network variable update to a host net

OpenLNS Programmer's Reference 259 Accessed Through AppDevice object RouterSide object Default Property None. Methods None. Properties • Class

OpenLNS Programmer's Reference 260 classIdValue The object class of the object. The following value is defined for the DataPoint object in the

OpenLNS Programmer's Reference 261 Element Description numMessages The number of lost messages. detailInfoObject The DetailInfo object from whi

OpenLNS Programmer's Reference 262 13 lcaNeuronModel3120E5 14 lcaNeuronModel3120E4 15 lcaNeuronModelPL3120E4 16 lcaNeuronModelCY7C5312

OpenLNS Programmer’s Reference iii Table of Contents Preface ...

OpenLNS Programmer’s Reference xxx

OpenLNS Programmer's Reference 263 object The DetailInfo object from which to get the information. Data Type Long. Read/Write Read only. Adde

OpenLNS Programmer's Reference 264 State Summary Describes the state of a device, router side, router, or system. This data is available for ap

OpenLNS Programmer's Reference 265 function go_unconfigured(). The device's service LED flashes at a one second rate in this state. 3 l

OpenLNS Programmer's Reference 266 Read/Write Read only. Added to API Prior to LNS Release 3.0. TransactionTimeouts Summary Contains the number

OpenLNS Programmer's Reference 267 Syntax errorCount = detailInfoObject.XmitErrors Element Description errorCount The number of errors. deta

OpenLNS Programmer's Reference 268 • RegisteredComponent • SelfDocConsistency • SelfDocumentation • UserTypeFileName • XifPath Method

OpenLNS Programmer's Reference 269 have been updated or modified since the device’s XIF was imported. This method allows you to update the Devi

OpenLNS Programmer's Reference 270 resynchronization. Added to API LNS Release 3.20. Properties The DeviceTemplate object contains the followi

OpenLNS Programmer's Reference 271 BitmapFilePath Summary Specify the path and file name of a bitmap (*.BMP file) representation of the object

OpenLNS Programmer's Reference 272 added to the API. ComponentApps Summary Contains the ComponentApps collection object associated with the sp

OpenLNS Programmer's Reference xxxi Preface This document provides an overview of how to use the OpenLNS Object Server Active X control, and it

OpenLNS Programmer's Reference 273 DeviceClass Summary Stores the device class for a device template. Availability Local, full, and lightweight

OpenLNS Programmer's Reference 274 that specified by the application, and the program interface in the device matches the previously defined pr

OpenLNS Programmer's Reference 275 database, the commission will fail, and the NS, #72 lcaErrNsWrongChannel exception will be thrown. 1 lcaDe

OpenLNS Programmer's Reference 276 option is set. Note that the lcaDeviceValidationNoChannelValidation (1) and lcaDeviceValidationNoProgramId

OpenLNS Programmer's Reference 277 Availability Local, full, and lightweight clients. Syntax dynamicNvSupValue = dtObject.DynamicNvSupported El

OpenLNS Programmer's Reference 278 values: 0 Development program ID. 8 LonMark approved program ID. 9 LonMark prototype program ID. d

OpenLNS Programmer's Reference 279 device. FALSE. Device is a Neuron hosted device. dtObject The DeviceTemplate object to be acted on. Data

OpenLNS Programmer's Reference 280 object The AppDevice object to be acted on. Data Type Interface object. Read/Write Read only. Added to API

OpenLNS Programmer's Reference 281 may not contain the forward slash (/), back slash (\), period (.), and colon (:) characters. Availability L

OpenLNS Programmer's Reference 282 Availability Local, full, and lightweight clients. Syntax programIdValue = object.ProgramId Element Descrip

OpenLNS Programmer's Reference xxxii Purpose This document provides reference information for writing OpenLNS applications. Audience This guid

OpenLNS Programmer's Reference 283 Each DeviceTemplate object in an OpenLNS database may have a single device control registered for it. A nul

OpenLNS Programmer's Reference 284 template. The valid values for this property, which are contained in the ConstSelfDocConsistency constant,

OpenLNS Programmer's Reference 285 value that conflicts with the configurations of the devices using a template. If you set this property to a

OpenLNS Programmer's Reference 286 base name of the formatting file (.fmt) instead of the default. devTemplateObject The DeviceTemplate object

OpenLNS Programmer's Reference 287 • Parent • _NewEnum Methods The DeviceTemplates object contains the following methods. • Add • ItemByHan

OpenLNS Programmer's Reference 288 This value is not supported. Added to API Prior to LNS Release 3.0. ItemByHandle Summary Retrieves a Device

OpenLNS Programmer's Reference 289 name A Long value specifying the collection index of the object to remove, or a String value specifying the

OpenLNS Programmer's Reference 290 Element Description returnValue The number of objects in the collection as a long integer. object The collec

OpenLNS Programmer's Reference 291 Availability Local, full, lightweight, and independent clients. Note that some collection objects are not av

OpenLNS Programmer's Reference 292 Error An Error object represents the information for a single Object Server error. Errors are handled by LC

OpenLNS Programmer's Reference xxxiii OpenLNS Server Computer (Smaller Network) System requirements for computers running the OpenLNS Server on

OpenLNS Programmer's Reference 293 Category Summary Contains the error category represented by the Error object. Availability Local, full, an

OpenLNS Programmer's Reference 294 Syntax classIdValue = object.ClassId Element Description classIdValue The object class of the object. The f

OpenLNS Programmer's Reference 295 errObject The Error object to be acted on. Data Type Long. Read/Write Read only. Added to API Prior to LN

OpenLNS Programmer's Reference 296 You can use the AppDevices collection object's ItemByHandle method to get the AppDevice corresponding t

OpenLNS Programmer's Reference 297 ConnErrIndex1 property is a message tag index. 2 lcaLNSIndexTypeDynamicMessageTag The index in the corresp

OpenLNS Programmer's Reference 298 The index in the corresponding ConnErrIndex2 property is a message tag index. 2 lcaLNSIndexTypeDynamicMess

OpenLNS Programmer's Reference 299 contained in the ConstClassIds constant, are as follows: 0 lcaClassIdObjectServer 1 lcaClassIdNetwork 2

OpenLNS Programmer's Reference 300 51 lcaClassIdExtensions 52 lcaClassIdRecoveryStatus 53 lcaClassIdCreditInfo 54 lcaClassIdAccount 55 lca

OpenLNS Programmer's Reference 301 Syntax errorId = errorObject.ErrorObjHandle Element Description errorObject The Error object to be acted on.

OpenLNS Programmer's Reference 302 Data Type Object. Read/Write Read only. Added to API Depends on the object used to access the property. Gene

OpenLNS Programmer's Reference xxxiv • Microsoft Visual Studio 2010 or Microsoft Visual Studio 2008 (.NET Framework 3.5) for development of Vi

OpenLNS Programmer's Reference 303 • Value2 • Value3 ClassId Summary Identifies the object class of this object. This property allows the o

OpenLNS Programmer's Reference 304 extension The Extension object to be acted upon. Data Type Boolean. Read/Write Read/write. Added to API LN

OpenLNS Programmer's Reference 305 Handle Summary Contains the handle associated with the Extension object. This property enables the Extension

OpenLNS Programmer's Reference 306 Extensions collection containing this Extension. To determine the object type before using this method, use

OpenLNS Programmer's Reference 307 specified object. object Any object for which the parent is desired. Data Type Object. Read/Write Read only

OpenLNS Programmer's Reference 308 Value2 Summary Stores user-specified object data. Availability Local, full, and lightweight clients. Syntax

OpenLNS Programmer's Reference 309 Variant type in binary large objects (BLOBs) of up to 65,000 bytes. Values are tagged with a unique key to e

OpenLNS Programmer's Reference 310 ObjectServer object Router object Subnet object Subsystem object System object Default Property Item proper

OpenLNS Programmer's Reference 311 handle The handle of the Extension to be retrieved. Added to API OpenLNS. Remove Summary Removes an object

OpenLNS Programmer's Reference 312 Read/Write Read only. Added to API Depends on the object used to access the property. Generally, this proper

OpenLNS Programmer's Reference xxxv If you have technical questions that are not answered by this document, the online help files provided with

OpenLNS Programmer's Reference 313 Data Type Object. Read/Write Read only. Added to API Depends on the object used to access the property. Gen

OpenLNS Programmer's Reference 314 Syntax retrievedObject = collObject._NewEnum Element Description retrievedObject An expression that evaluate

OpenLNS Programmer's Reference 315 • TxTimeOut Methods The FileTransfer object contains the following methods: • AddTarget • ClearTargets •

OpenLNS Programmer's Reference 316 Availability Local, full, and lightweight clients. Syntax ftObject.ClearTargets Element Description ftObject

OpenLNS Programmer's Reference 317 WriteFile Summary Writes a file to an AppDevice in the file transfer target list. You must first add the sel

OpenLNS Programmer's Reference 318 • FileSize • FileType • HostTimeOut • Parent • PriorityFlag • ReadBufferLength • RetryCount •

OpenLNS Programmer's Reference 319 classIdValue The object class of the object. The following value is defined for the FileTransfer object in

OpenLNS Programmer's Reference 320 FileIndex Summary Specifies the file index to be used during operations on the FileTransfer object. Note: O

OpenLNS Programmer's Reference 321 FileInfo Summary Returns a 16-byte string describing any of the files on the app devices that have been adde

OpenLNS Programmer's Reference 322 files. This property will return the file size of the file that is using the value assigned to the FileIndex

OpenLNS Programmer's Reference xxxvi Content This guide includes the following content: • OpenLNS Object Server. Introduces the OpenLNS Object

OpenLNS Programmer's Reference 323 Syntax timeoutValue = fileTransObject.HostTimeOut Element Description timeoutValue The timeout value. Th

OpenLNS Programmer's Reference 324 Syntax priorityFlag = fileTransObject.PriorityFlag Element Description priorityFlag The returned priority

OpenLNS Programmer's Reference 325 A value of 0 indicates that the number of retries will be calculated based on the network topology. The def

OpenLNS Programmer's Reference 326 This method requires network communication; however, you can invoke it while the network management mode (Mg

OpenLNS Programmer's Reference 327 less than or equal to the receive timeout value. The default value is 0,which means that OpenLNS calculate

OpenLNS Programmer's Reference 328 • DateFormatSeparator • DateFormatSeparatorSource • DecimalPointCharacter • DecimalPointCharacterSource

OpenLNS Programmer's Reference 329 CategoryPreferenceList Summary Establishes the format to be used when displaying the formatted value of a da

OpenLNS Programmer's Reference 330 search for matches for each alternate format specified starting with the first entry in the list. If you spe

OpenLNS Programmer's Reference 331 Data Type Integer. Read/Write Read only. Added to API Depends on the object used to access the property. Ge

OpenLNS Programmer's Reference 332 formatLocale The FormatLocale object being acted upon. source The value of the DateFormatSeparatorSource pro

OpenLNS Programmer's Reference xxxvii

OpenLNS Programmer's Reference 333 DecimalPointCharacter Summary Determines which will be used to indicate decimal places when a formatted valu

OpenLNS Programmer's Reference 334 UserDefaultRegionalSetting Select this value to have OpenLNS set the associated property automatically, base

OpenLNS Programmer's Reference 335 DoubleFloatPrecision Summary Determines the precision that will be used when displaying double-float values.

OpenLNS Programmer's Reference 336 FallbackFormat Summary Specifies the default type that should be used to display a data point’s formatted va

OpenLNS Programmer's Reference 337 TAB character (0x09). 2 lcaFormatRawHexPacked Use "RAW_HEX_PACKED" as the fallback type. This is

OpenLNS Programmer's Reference 338 Data Type Long. Read/Write Read/write. Added to API LNS Release 3.20. LanguageId Summary Determines the lang

OpenLNS Programmer's Reference 339 code A 3-letter identifier for the language specified for the FormatLocale object. The available language co

OpenLNS Programmer's Reference 340 formatLocale The FormatLocale object being acted upon. source The value of the LanguageIdSource property. Th

OpenLNS Programmer's Reference 341 ListSeparatorCharacter Summary Determines which symbol is used to separate items in the formatted value that

OpenLNS Programmer's Reference 342 based on the Windows regional settings set by the user on the computer running your application. A user can

OpenLNS Programmer's Reference 1 1 OpenLNS Object Server This chapter introduces the OpenLNS Object Server, describes the OpenLNS Object model

OpenLNS Programmer's Reference 343 MeasurementUnits Summary Determines the measurement units (Systeme Internationale [SI metric] or U.S.) that

OpenLNS Programmer's Reference 344 0 lcaMeasurementUnitsSI Displays the formatted values using the metric measurement system. 1 lcaMeasurem

OpenLNS Programmer's Reference 345 running your application. The default settings may vary depending on which operating system is installed on

OpenLNS Programmer's Reference 346 clients. Syntax parentObject = object.Parent Element Description parentObject The object that is the parent

OpenLNS Programmer's Reference 347 Here are some example strings you could use for this property, with examples of how the short date would app

OpenLNS Programmer's Reference 348 source The value of the ShortDateFormatSource property. The possible values for this element, which are con

OpenLNS Programmer's Reference 349 restrictions to how each part of the time can be displayed. This applies to format specifications containing

OpenLNS Programmer's Reference 350 automatically update it with the new separator character for you. You can use the ShortTimeFormatSource prop

OpenLNS Programmer's Reference 351 control panel Regional Options applet. This is the default. 1 lcaFormatLocaleSource SystemDefaultRegional

OpenLNS Programmer's Reference 352 Syntax formatLocale.ShortTimeFormat = timeFormat Element Description formatLocale The FormatLocale object

OpenLNS Programmer's Reference 2 Introduction The OpenLNS Object Server ActiveX Control provides high-level services for installing, diagnosing

OpenLNS Programmer's Reference 353 based on the system default Windows regional settings of the computer running your application. The default

OpenLNS Programmer's Reference 354 not available. In this case, Systeme Internationale measurement units, and U.S. options for everything else,

OpenLNS Programmer's Reference 355 such as the format used to display dates and times, and the unit of measurement associated with the formatte

OpenLNS Programmer's Reference 356 FormatLocales collection. You can determine the name of a FormatLocale object by reading its Name property.

OpenLNS Programmer's Reference 357 ClassId Summary Identifies the object class of this object. This property allows the object type to be dete

OpenLNS Programmer's Reference 358 FormatLocales collection by passing its index (ordinal position) within that collection as the argument for

OpenLNS Programmer's Reference 359 Added to API Depends on the object used to access the property. Generally, this property exists for an objec

OpenLNS Programmer's Reference 360 Set fsObject = dpObject.FormatSpec fsObject.FormatName = "SNVT_temp_f#SI" Set dpObject.FormatSpec

OpenLNS Programmer's Reference 361 • ClassId • FormatName • FormatType • Index • Parent • Precision • ProgramId • Scope • Units • U

OpenLNS Programmer's Reference 362 Syntax altNameCount = fsObject.AltFormatNamesCount Element Description altNameCount The number of alternat

OpenLNS Programmer’s Reference iv Alias ...

OpenLNS Programmer's Reference 3 The remainder of the OpenLNS Objects originate from the three Networks collections. A network is represented

OpenLNS Programmer's Reference 363 FormatType property is set to lcaFormatTypeNamed (0). In that case, the Scope and ProgramId properties are u

OpenLNS Programmer's Reference 364 Element Description fsObject The FormatSpec object to be acted on. formNameValue The FormatName as a string.

OpenLNS Programmer's Reference 365 The lcaFormatTypeNamed(0) value is the default value for user-defined network variables. 1 lcaFormatTypeNv

OpenLNS Programmer's Reference 366 Syntax indexValue = fsObject.Index Element Description fsObject The FormatSpec object to be acted on. indexV

OpenLNS Programmer's Reference 367 points in permanent monitor sets. Syntax precisionValue = object.Precision Element Description precisionValu

OpenLNS Programmer's Reference 368 will be set to match the program ID of the device containing the monitor point or data point. • If the For

OpenLNS Programmer's Reference 369 2 lcaResourceScopeSubclass This scope applies to all devices of a specified device class and device subcla

OpenLNS Programmer's Reference 370 Read/Write Read/write. Added to API LNS Release 3.0. Units Summary Indicates the name of the units that appl

OpenLNS Programmer's Reference 371 Data Type Single. Read/Write Read only. Added to API LNS Release 3.0. UnitsMultiplier Summary Determines how

OpenLNS Programmer's Reference 372 interfaces that cannot be modified. The custom interfaces that have been added to a device can be accessed t

OpenLNS Programmer's Reference 4 a Subsystem. Different Subsystems can contain devices with the same name, however. For example, a building m

OpenLNS Programmer's Reference 373 • Version Methods The Interface object contains the following methods: • AddCompatibleNv • AddCompatible

OpenLNS Programmer's Reference 374 the ProgrammaticName property. sourceNvObj The NetworkVariable object which the new network variable is base

OpenLNS Programmer's Reference 375 ConstLNSInterfaceCompNvEx constant, are as follows: 0 lcaLNS_PollPassthrough The created network variable

OpenLNS Programmer's Reference 376 as the source network variable. This method is used to construct an interface object for a host application

OpenLNS Programmer's Reference 377 Element Description nvObject The compatible network variable to be returned. A compatible network variable i

OpenLNS Programmer's Reference 378 The created network variable will have polling enable. Added to API Prior to LNS Release 3.0. AddNvFromStri

OpenLNS Programmer's Reference 379 Syntax newTypeSpec = interface.CreateTypeSpec(objectType) Element Description newTypeSpec newTypeSpec is t

OpenLNS Programmer's Reference 380 lcaConfigPropOptSetDefaults option), this method requires that the configuration property values be uploaded

OpenLNS Programmer's Reference 381 lcaConfigPropOptSetDefaults Sets the configuration property values in the AppDevice object to the default co

OpenLNS Programmer's Reference 382 default values may cause the download operation to fail. To exclude those configuration properties from a do

OpenLNS Programmer's Reference 5 Object Naming Convention While the documentation currently references most objects by their base names, it is

OpenLNS Programmer's Reference 383 ORed with lcaConfigPropOptLoadUnknown (4) and lcaConfigPropOptLoadValues (1), LNS would set all configuratio

OpenLNS Programmer's Reference 384 However, updates to the device initiated by the other flags will be cancelled. For example, when combining t

OpenLNS Programmer's Reference 385 Added to API Prior to LNS Release 3.0. RemoveNv Summary Removes a network variable from the Interface object

OpenLNS Programmer's Reference 386 0 lcaConfigPropOptLoadDefinitions Reads the template file and loads the configuration property definitions

OpenLNS Programmer's Reference 387 upload all unknown values in the OpenLNS database from the physical device on the network. Alternatively, yo

OpenLNS Programmer's Reference 388 • MaxNvSupported • MessageTags • Name • NetworkVariables • Parent • StaticNvCount • SupportsDyna

OpenLNS Programmer's Reference 389 Added to API Prior to LNS Release 3.0. ConfigPropertiesAvailable Summary Indicates whether configuration pro

OpenLNS Programmer's Reference 390 CpByHandle Summary Retrieves the ConfigProperty object contained in the Interface property of an AppDevice o

OpenLNS Programmer's Reference 391 DynamicLonMarkObjectCapacity Summary Indicates the number of dynamic LonMarkObject objects (functional block

OpenLNS Programmer's Reference 392 DynamicMessageTags Summary Returns the collection of dynamic MessageTag objects contained by this interface.

OpenLNS Programmer's Reference 6

OpenLNS Programmer's Reference 393 Added to API Prior to LNS Release 3.0. MaxNvInUse Summary Indicates the current maximum network variable ind

OpenLNS Programmer's Reference 394 Syntax maxNvValue = interfaceObject.MaxNvSupported Element Description interfaceObject The Interface objec

OpenLNS Programmer's Reference 395 Data Type String. Read/Write Read/write. Added to API Depends on the object used to access the property. Ge

OpenLNS Programmer's Reference 396 StaticNvCount Summary Indicates the number of network variables that are statically defined on the device th

OpenLNS Programmer's Reference 397 You can determine if a LonMarkObject is static or dynamic by reading its IsDynamic property. FALSE. The st

OpenLNS Programmer's Reference 398 Interfaces The Interfaces object is a collection of Interface objects. This collection contains the set of

OpenLNS Programmer's Reference 399 lcaErrDuplicateKey exception will be thrown. sourceInterfaceObj The existing Interface object used to create

OpenLNS Programmer's Reference 400 some objects containing this property are not available to Independent clients. Syntax classIdValue = object

OpenLNS Programmer's Reference 401 Independent clients. Syntax retrievedObject = collObject.Item(index) retrievedObject = collObject.Item(strin

OpenLNS Programmer's Reference 402 you can browse a collection to find a particular item by using the _NewEnum property. See the IEnumVARIANT i

OpenLNS Programmer's Reference 7 2 Objects This chapter describes the objects in the OpenLNS Object hierarchy, and details their properties,

OpenLNS Programmer's Reference 403 Properties The LdrfLanguage object contains the following properties: • ClassId • Extension • LanguageCod

OpenLNS Programmer's Reference 404 property types, functional profiles, and enumeration types can all reference text information used to descri

OpenLNS Programmer's Reference 405 Data Type String. Read/Write Read only. Added to API LNS Release 3.0. LanguageCode Summary Contains the 3-l

OpenLNS Programmer's Reference 406 ldrfCode A 3-letter identifier for the language that the LdrfLanguage object applies to. The available langu

OpenLNS Programmer's Reference 407 ldrfId The 32-bit ID representing this language. This value is not normally used by OpenLNS clients unless

OpenLNS Programmer's Reference 408 object Any object for which the parent is desired. Data Type Object. Read/Write Read only. Added to API Dep

OpenLNS Programmer's Reference 409 Independent clients. Syntax classIdValue = object.ClassId Element Description classIdValue The object class

OpenLNS Programmer's Reference 410 Independent clients. Syntax retrievedObject = collObject.Item(index) retrievedObject = collObject.Item(strin

OpenLNS Programmer's Reference 411 you can browse a collection to find a particular item by using the _NewEnum property. See the IEnumVARIANT i

OpenLNS Programmer's Reference 412 Methods The LonMarkAlarm object does not contain any methods. Properties The LonMarkObject object contains t

OpenLNS Programmer's Reference 8 Account Description Represents an OpenLNS licensing account. Reserved for future use. Added to API Prior to L

OpenLNS Programmer's Reference 413 255 lcaAlarmTypeNull Data Type Integer. Read/Write Read only. Added to API Prior to LNS Release 3.0. Clas

OpenLNS Programmer's Reference 414 LonMarkObject that caused the current alarm condition. LonMarkAlarm The LonMarkAlarm object being acted upon

OpenLNS Programmer's Reference 415 ObjectId Summary Returns the ID of the LonMarkObject to which this LonMarkAlarm applies. On static interface

OpenLNS Programmer's Reference 416 this property exists for an object as soon as the object is added to the API. PriorityLevel Summary Returns

OpenLNS Programmer's Reference 417 For example, the millisecond before the end of this millennium would be: 2999/12/31 23:59:59:999. Data Typ

OpenLNS Programmer's Reference 418 • ClassId • ComponentApps • ConfigProperties • Description • Extensions • FuncProfileDescription • Fu

OpenLNS Programmer's Reference 419 The network variable and LonMarkObject must belong to the same device interface for this method to succeed.

OpenLNS Programmer's Reference 420 network variables and LonMarkObjects that reflect the device’s functionality on the network. You can use the

OpenLNS Programmer's Reference 421 Syntax object.MoveToInterface newInterface Element Description object The LonMarkObject to be acted upon. n

OpenLNS Programmer's Reference 422 • Index • IsDynamic • LonMarkAlarm • Mode • Name • NetworkVariables • Parent • ParentInterface • Pr

OpenLNS Programmer's Reference 9 example, when the object was accessed using the Parent property of another object). Availability Local, full,

OpenLNS Programmer's Reference 423 4 lcaAlarmFormatUShortStr 1-byte unsigned decimal string. 5 lcaAlarmFormatLong 2-byte integer. 6 lcaAl

OpenLNS Programmer's Reference 424 object The object to be acted on. Data Type Integer. Read/Write Read only. Added to API Depends on the obj

OpenLNS Programmer's Reference 425 Description Summary Stores description information about the LonMarkObject object. Availability Local, full,

OpenLNS Programmer's Reference 426 FuncProfileDescription Summary Provides a desciptive comment of the functional profile associated with the L

OpenLNS Programmer's Reference 427 FuncProfileName Summary Returns the functional profile name associated with the LonMarkObject. This property

OpenLNS Programmer's Reference 428 Availability Local, full, and lightweight clients. Syntax indexValue = lmObject.Index Element Description lm

OpenLNS Programmer's Reference 429 Read/Write Read only. Added to API Prior to LNS Release 3.0. Mode Summary Returns the scope of the function

OpenLNS Programmer's Reference 430 -1 lcaResourceScopeUnknown The scope of the resource file is not known, or could not be found. -2 lcaRes

OpenLNS Programmer's Reference 431 Added to API Prior to LNS Release 3.0. Name Summary Specifies the name of an object as a character string.

OpenLNS Programmer's Reference 432 Syntax parentObject = object.Parent Element Description parentObject The object that is the parent of the sp

OpenLNS Programmer's Reference 10 stringValue A string description of the object. object The object to be acted on. Data Type Long. Read/Writ

OpenLNS Programmer's Reference 433 Added to API LNS Release 3.20. PrincipalNv Summary Returns the principal NetworkVariable object associated

OpenLNS Programmer's Reference 434 Element Description progName The programmatic name of the object. Object The LonMarkObject to be acted on.

OpenLNS Programmer's Reference 435 Syntax statusObject = lmObject.ReportMask Element Description statusObject The ObjectStatus object returned.

OpenLNS Programmer's Reference 436 3 lcaLonMarkObjectRequestSelfTest Performs a self-test on the object. The SelfTestResults property of the

OpenLNS Programmer's Reference 437 in the LonMarkAlarm property of the LonMarkObject will be cleared until the next alarm condition occurs. 11

OpenLNS Programmer's Reference 438 To run a self-test on an object where the result may take more than 20 seconds to complete, follow these ste

OpenLNS Programmer's Reference 439 Status Summary Stores an ObjectStatus object which contains information reflecting the current status of the

OpenLNS Programmer's Reference 440 TypeIndex Summary Returns the type index of the LonMark object. Each LonMarkObject object uses a type define

OpenLNS Programmer's Reference 441 Data Type TypeSpec object. Read/Write Read only. Added to API OpenLNS. LonMarkObjects A LonMarkObjects objec

OpenLNS Programmer's Reference 442 switch. In OpenLNS, function blocks are represented by LonMarkObject objects. Some custom device interfaces

OpenLNS Programmer's Reference 11 • Add • Remove Add Summary Adds an object to the specified collection. Availability Local, full, lightweig

OpenLNS Programmer's Reference 443 brackets ([ ]), periods (.) or commas (,). fbType Enter a value between 0-25,000. You can use this value to

OpenLNS Programmer's Reference 444 lcaTypeSpecLmo, or it is invalid in any other way. Availability Local, full, and lightweight clients. Synt

OpenLNS Programmer's Reference 445 Syntax retrievedObject = collection.ItemByProgrammaticName progName Element Description retrievedObject The

OpenLNS Programmer's Reference 446 acted upon. deviceIndex A Long value indicating the device index number of the LonMarkObject to be deleted.

OpenLNS Programmer's Reference 447 ClassId Summary Identifies the object class of this object. This property allows the object type to be dete

OpenLNS Programmer's Reference 448 LonMarkObjects collection by passing its index (ordinal position) within that collection as the argument for

OpenLNS Programmer's Reference 449 Comments The parent object is determined by the means in which a child object is accessed, not by the OpenLN

OpenLNS Programmer's Reference 450 • AppDeviceName • ClassId • ConnectDescTemplate • Direction • Index • IsDynamic • MtHubs • MtTar

OpenLNS Programmer's Reference 451 • A static or dynamic message tag may only appear in one connection (it may be a hub or target, but not bot

OpenLNS Programmer's Reference 452 You can use the OnNodeConnChangeEvent to track when connections are created or modified with this method. Av

OpenLNS Programmer's Reference 12 Syntax classIdValue = object.ClassId Element Description classIdValue The object class of the object. The fo

OpenLNS Programmer's Reference 453 • Index • IsDynamic • MtHubs • MtTargets • Name • Parent AddressTableIndex Summary Contains the ad

OpenLNS Programmer's Reference 454 AppDevice Summary Identifies the AppDevice object containing this message tag. Availability Local, full, an

OpenLNS Programmer's Reference 455 Read/Write Read only. Added to API Depends on the object used to access the property. Generally, this proper

OpenLNS Programmer's Reference 456 constant, are as follows: 0 lcaMtDirectionInput The message tag is an input message tag. 2 lcaMtDirectio

OpenLNS Programmer's Reference 457 object The MessageTag object to be acted on. Data Type Boolean. Read/Write Read only. Added to API LNS Rel

OpenLNS Programmer's Reference 458 Name Summary Specifies the name of an object as a character string. This property is case sensitive. Search

OpenLNS Programmer's Reference 459 MessageTags A MessageTags object is a collection of MessageTag objects. Note that the Interface object cont

OpenLNS Programmer's Reference 460 devices is described in the OpenLNS Programmer’s Guide. The name of the new message tag (as specified with t

OpenLNS Programmer's Reference 461 name A Long value specifying the collection index of the object to remove, or a String value specifying the

OpenLNS Programmer's Reference 462 Element Description returnValue The number of objects in the collection as a long integer. object The collec

OpenLNS Programmer’s Reference v DetailInfo ... 74 Device Tem

OpenLNS Programmer's Reference 13 Element Description retrievedObject The object retrieved from the collection. collObject The collection objec

OpenLNS Programmer's Reference 463 Parent Summary Returns the object that spawned the current child object. The parent object is determined by

OpenLNS Programmer's Reference 464 Data Type Object. Read/Write Read only. Added to API OpenLNS. MonitorSet A MonitorSet object represents a s

OpenLNS Programmer's Reference 465 use in multiple client sessions or that you intend to use multiple times, you should use the permanent Monit

OpenLNS Programmer's Reference 466 • Parent • Tag Methods The object contains the following methods. • Close • Disable • Enable • Open

OpenLNS Programmer's Reference 467 network variable monitor point. If you explicitly disable monitoring of a single monitor point, you can only

OpenLNS Programmer's Reference 468 are not available on Independent clients. Syntax object.Enable doPoll Element Description object The Monitor

OpenLNS Programmer's Reference 469 clients. Syntax monSetObject.Open doEnable, doPoll Element Description monSetObject The MonitorSet object t

OpenLNS Programmer's Reference 470 monitor the monitor points in the monitor set. Added to API LNS Release 3.0. Properties The MonitorSet obje

OpenLNS Programmer's Reference 471 IsEnabled Summary Indicates whether the monitor set is enabled. A monitor point must be enabled before poll

OpenLNS Programmer's Reference 472 IsOpen Summary Indicates whether the specified object is currently open. You can open the MonitorSet object

OpenLNS Programmer's Reference 14 ActivationLicense An ActivationLicense object represents a snapshot of the current activation license and rel

OpenLNS Programmer's Reference 473 Element Description isPollingEnabledFlag A Boolean value indicating whether polled monitoring is enabled. TR

OpenLNS Programmer's Reference 474 The MsgMonitorOptions object contained within this property is not passed by reference. If you acquire a Msg

OpenLNS Programmer's Reference 475 (.), and colon (:) characters. Availability Local, full, lightweight, and independent clients. Note that so

OpenLNS Programmer's Reference 476 The NvMonitorOptions object contained within this property is not passed by reference. If you acquire a NvMo

OpenLNS Programmer's Reference 477 clients. Syntax parentObject = object.Parent Element Description parentObject The object that is the parent

OpenLNS Programmer's Reference 478 Independent clients. Syntax tagValue = Object.Tag Element Description Object The monitor point or monitor se

OpenLNS Programmer's Reference 479 lcaMgmtModeDeferConfigUpdates (1), you must change the management mode to lcaMgmtModePropagateConfigUpdates

OpenLNS Programmer's Reference 480 index of the MonitorSet object to be removed, or a String value specifying the name of the MonitorSet object

OpenLNS Programmer's Reference 481 Element Description returnValue The number of objects in the collection as a long integer. object The collec

OpenLNS Programmer's Reference 482 Parent Summary Returns the object that spawned the current child object. The parent object is determined by

OpenLNS Programmer's Reference 15 • DeviceCapacity • DeviceCapacityConsumed • ExpirationDate • LicesnseId • LicenseStatus • IsTrialLicens

OpenLNS Programmer's Reference 483 Data Type Object. Read/Write Read only. Added to API OpenLNS. MsgMonitorOptions The MsgMonitorOptions objec

OpenLNS Programmer's Reference 484 • UseAsyncSend Methods The MsgMonitorOptions object does not contain any methods. Properties The MsgMonitor

OpenLNS Programmer's Reference 485 Independent clients. Syntax classIdValue = object.ClassId Element Description classIdValue The object class

OpenLNS Programmer's Reference 486 FilterBySource Summary Indicates whether message tag values will be filtered by the source device. This prop

OpenLNS Programmer's Reference 487 codes in the range 80–126 and 128–255 cannot be received by an OpenLNS application. This is because these c

OpenLNS Programmer's Reference 488 priorityValue A Boolean value. TRUE. Priority is used when polling or explicitly updating a message monit

OpenLNS Programmer's Reference 489 1–15. This property applies to network management messages only. monOptsObject The MsgMonitorOptions object

OpenLNS Programmer's Reference 490 service. The device does not send acknowledgment messages; however, repeat messages are sent to the device

OpenLNS Programmer's Reference 491 been successfully sent, as described earlier. However, you can also use the OnMsgMonitorPointErrorEvent and

OpenLNS Programmer's Reference 492 with the Write method because it reduces the time required to update the values on the network. FALSE. Ope

OpenLNS Programmer's Reference 16 Comments This property allows the object type to be determined when it is unknown (for example, when the obje

OpenLNS Programmer's Reference 493 MsgMonitorPoint A MsgMonitorPoint represents a single monitored or controlled message tag. You can use messa

OpenLNS Programmer's Reference 494 Advise Summary Enables update and error events for an object that implements the ILcaMsgMonitorPointListener

OpenLNS Programmer's Reference 495 For example, if you call the Disable method on a MsgMonitorPoint object named Point A, and then call the Dis

OpenLNS Programmer's Reference 496 Syntax object.Ensable Element Description object The MsgMonitorPoint object to be enabled. Added to API LNS

OpenLNS Programmer's Reference 497 Syntax mpObject.Unadvise tag Element Description tag An Integer type. This tag parameter should use the tag

OpenLNS Programmer's Reference 498 CurrentOptions Summary Contains the current monitoring options for this message monitor point. Once the moni

OpenLNS Programmer's Reference 499 message monitor point is opened. These options are read when the monitor set containing the monitor point is

OpenLNS Programmer's Reference 500 InputFormatSpec Summary Contains the FormatSpec object used to determine the format for incoming messages fo

OpenLNS Programmer's Reference 501 Data Type String. Read/Write Read/write. Added to API Depends on the object used to access the property. Ge

OpenLNS Programmer's Reference 502 msgMonitorPointObject.OutputFormatSpec fsObject.AltFormatName = "SNVT_temp_f#SI" Set msgMonitorPoi

OpenLNS Programmer's Reference 17 database, excluding NSDs and routers. A device that has been added without specifying both a device template

OpenLNS Programmer's Reference 503 open in order for you to access this property. When the AppDevice object's GetMessagePoint method is ca

OpenLNS Programmer's Reference 504 Tag Summary Stores any extra data associated with the monitor point or monitor set. The data stored in this

OpenLNS Programmer's Reference 505 Events The MsgMonitorPoint object contains the following events: • UpdateErrorEvent • UpdateEvent Update

OpenLNS Programmer's Reference 506 Element Description UpdateType This element always returns the value 0. The possible values for this param

OpenLNS Programmer's Reference 507 13 lcaMonitorEventTypeNvComplete A completion code has returned for the monitor point. 14 lcaMonitorEventT

OpenLNS Programmer's Reference 508 Added to API LNS Release 3.0. MsgMonitorPoints The MsgMonitorPoints object contains a collection of MsgMoni

OpenLNS Programmer's Reference 509 able to use the MsgMonitorPoint to send messages to all the devices that the MessageTag object is bound to a

OpenLNS Programmer's Reference 510 are not available on Independent clients. Syntax msgMpObject = msgMpColl.Add msgMpName targetDevice connDesc

OpenLNS Programmer's Reference 511 indexName A Long value specifying the collection index of the MsgMonitorPoint object to remove, or a String

OpenLNS Programmer's Reference 512 Syntax returnValue = object.Count Element Description returnValue The number of objects in the collection as

OpenLNS Programmer's Reference 18 Data Type String. Read/Write Read only. Added to API OpenLNS. LicenseStatus Summary Indicates whether the

OpenLNS Programmer's Reference 513 Parent Summary Returns the object that spawned the current child object. The parent object is determined by

OpenLNS Programmer's Reference 514 Data Type Object. Read/Write Read only. Added to API OpenLNS. Network The Network object represents a singl

OpenLNS Programmer's Reference 515 • ServerIdentifier • System Methods The Network object contains the following methods. • Backup • Canc

OpenLNS Programmer's Reference 516 network The Network object to be acted upon. systemPath The directory to which the backup is to be copied. T

OpenLNS Programmer's Reference 517 Syntax network.CancelValidation Element Description network The Network object to be acted upon. Added to A

OpenLNS Programmer's Reference 518 Syntax network.CompactDb Element Description network The Network object to be acted on. Added to API Prior

OpenLNS Programmer's Reference 519 collection. If this method is being invoked by a remote client, the application program must set the remote

OpenLNS Programmer's Reference 520 computer without the OpenLNS Server running on the host. You may not access the network database. The same

OpenLNS Programmer's Reference 521 if you install a new network interface on the computer). In all other scenarios (e.g. when operating as a Lo

OpenLNS Programmer's Reference 522 to use the NSD information which was previously associated with a remote client running on another computer

OpenLNS Programmer's Reference 19 whether the activation license is a trial license. TRUE. The activation license is a trial license. FALSE.

OpenLNS Programmer's Reference 523 it is not open, the LCA, #67 lcaErrSystemNotOpen exception will be thrown. You should consider using the Val

OpenLNS Programmer's Reference 524 validation without attempting to repair any of the errors it discovers. In this case, the Validate method re

OpenLNS Programmer's Reference 525 • Channels • ClassId • CurrentMonitorSets • DatabasePath • Description • EventInterval • Extension

OpenLNS Programmer's Reference 526 order to successfully open this remote network. TRUE. OpenLNS changes the network management mode when ne

OpenLNS Programmer's Reference 527 C:\MyBMPs\Object.BMP). Added to API Prior to LNS Release 3.0. Channels Summary Contains the Channels collec

OpenLNS Programmer's Reference 528 commissioned into your client’s NSD for a given network. The CurrentMonitorSets property returns a MonitorS

OpenLNS Programmer's Reference 529 Syntax dbPath = object.DatabasePath Element Description dbPath The full path of the global OpenLNS database

OpenLNS Programmer's Reference 530 EventInterval property expires, OpenLNS will not call the GetNextEvent service right away. Instead, it will

OpenLNS Programmer's Reference 531 Element Description extensionsColl The Extensions collection object. object The object whose Extensions coll

OpenLNS Programmer's Reference 532 • Large (48x48) with 256 colors Added to API Prior to LNS Release 3.0. IsOpen Summary Indicates whether the

OpenLNS Programmer's Reference 20 Data Type String. Read/Write Read only. Added to API OpenLNS. RunTimeLimit Summary The maximum number of

OpenLNS Programmer's Reference 533 Read/Write Read only. Added to API LNS Release 3.0. MyVNI Summary Contains the AppDevice object which is us

OpenLNS Programmer's Reference 534 they are added to the API. NetworkServiceDevices Summary Contains the NetworkServiceDevices collection objec

OpenLNS Programmer's Reference 535 OriginalName Summary Contains the network's original name as defined on the OpenLNS Server. The proper

OpenLNS Programmer's Reference 536 RemoteNetworkName Summary Allows the name of the network as seen in the RemoteNetworks and VNINetworks to be

OpenLNS Programmer's Reference 537 ServerIdentifier Summary Provides an identification string for the OpenLNS Server that has opened this netwo

OpenLNS Programmer's Reference 538 Systems Summary Returns the Systems collection containing the System object. Only one System is allowed for

OpenLNS Programmer's Reference 539 Add Summary Defines a new Network object. You can create a new network, or import an existing network. Ava

OpenLNS Programmer's Reference 540 can be no more than 230 characters long, including any characters OpenLNS adds to create an absolute path. O

OpenLNS Programmer's Reference 541 identify the network to be deleted by its name, which is stored in the Name property of the Network object,

OpenLNS Programmer's Reference 542 • Count • Item • Parent • _NewEnum ClassId Summary Identifies the object class of this object. This pro

OpenLNS Programmer's Reference 21 Alias The following table summarizes the Alias object. Description Represents an alias in-use for a network

OpenLNS Programmer's Reference 543 added to the API. Item Summary Returns a Network object from a Networks collection. You can retrieve a Netwo

OpenLNS Programmer's Reference 544 object Any object for which the parent is desired. Data Type Object. Read/Write Read only. Added to API Dep

OpenLNS Programmer's Reference 545 Added to API Prior to LNS Release 3.0. Accessed Through NetworkInterfaces collection object. NetworkService

OpenLNS Programmer's Reference 546 Name Summary Specifies the name of an object as a character string. This property is case sensitive. Search

OpenLNS Programmer's Reference 547 NetworkInterfaces A NetworkInterfaces object represents a collection of NetworkInterface objects. This coll

OpenLNS Programmer's Reference 548 • Count • Item • _NewEnum ClassId Summary Identifies the object class of this object. This property allo

OpenLNS Programmer's Reference 549 Item Summary Returns a NetworkInterface object from a NetworkInterfaces collection. You can retrieve a Netwo

OpenLNS Programmer's Reference 550 foreach statements. Availability Local, full, and lightweight clients. Syntax retrievedObject = collObject._

OpenLNS Programmer's Reference 551 Properties The NetworkResources object contains the following properties: • AppDeviceCount • ClassId • E

OpenLNS Programmer's Reference 552 classIdValue The object class of the object. The following value is defined for the NetworkResources object

OpenLNS Programmer's Reference 22 Comments This property allows the object type to be determined when it is unknown (for example, when the obje

OpenLNS Programmer's Reference 553 Added to API LNS Release 3.20. ExclusiveSelectorsAvailable Summary Indicates the total number of exclusive

OpenLNS Programmer's Reference 554 GroupIdsAllocated Summary Indicates the number of LonTalk group IDs that have been allocated on the system.

OpenLNS Programmer's Reference 555 object Any object for which the parent is desired. Data Type Object. Read/Write Read only. Added to API Dep

OpenLNS Programmer's Reference 556 count The number of selectors that can be used by more than one connection in the system. networkResources T

OpenLNS Programmer's Reference 557 Added to API Prior to LNS Release 3.0. Accessed Through AppDevice object. NetworkServiceDevices object. Sys

OpenLNS Programmer's Reference 558 EndResetEvent Summary Disables the OnNetworkServiceDeviceResetNew event. Availability Local, full, and light

OpenLNS Programmer's Reference 559 Element Description appDevObject The AppDevice object to be returned. nsdObject The NetworkServiceDevice ob

OpenLNS Programmer's Reference 560 ConstClassIds constant: 40 lcaClassIdNetworkServiceDevice object The object to be acted on. Data Type In

OpenLNS Programmer's Reference 561 soon as they are added to the API. See the applicable object to determine what release it was introduced in.

OpenLNS Programmer's Reference 562 Added to API Prior to LNS Release 3.0. IconFilePath Summary Specifies the path and file name of an icon (*.I

OpenLNS Programmer’s Reference vi State ... 103 BufferCo

OpenLNS Programmer's Reference 23 added to the API. Comments The parent object is determined by the means in which a child object is accessed,

OpenLNS Programmer's Reference 563 LcaNsdType Summary Specifies the type of network service device, which determines whether its NSI is removed

OpenLNS Programmer's Reference 564 not using an OpenLNS high-performace network interface. nsdObject The NetworkServiceDevice object from whic

OpenLNS Programmer's Reference 565 Read/Write Read/write. Added to API Prior to LNS Release 3.0. NetworkInterfaceFlag Summary Specifies whether

OpenLNS Programmer's Reference 566 Added to API Prior to LNS Release 3.0. NsiHandle Summary Returns the unique identifier assigned to an NSI by

OpenLNS Programmer's Reference 567 NsiSubnetId Summary Contains the subnet ID associated with the network services interface (NSI). The NsiNod

OpenLNS Programmer's Reference 568 Parent Summary Returns the object that spawned the current child object. The parent object is determined by

OpenLNS Programmer's Reference 569 Class for nodes which move frequently. 2 lcaPingClassTemporary Class for temporary nodes. 3 lcaPingCla

OpenLNS Programmer's Reference 570 Remove Summary Removes an object from the specified collection. Availability Local, full, lightweight, and

OpenLNS Programmer's Reference 571 added to the API. Count Summary Returns the number of objects in a collection. You can use this property to

OpenLNS Programmer's Reference 572 stringExpression A string type specifying the name of the NetworkServiceDevice object to be retrieved. Data

OpenLNS Programmer's Reference 24 • Parent • _NewEnum Methods The Aliases object contains the following methods. • ItemByIndex • Refresh I

OpenLNS Programmer's Reference 573 Availability Local, full, and lightweight clients. Syntax retrievedObject = collObject._NewEnum Element Desc

OpenLNS Programmer's Reference 574 • AuthenticationFlag • ChangeableTypeSupport • ClassId • ConfigClassFlag • ConfigProperties • ConnectD

OpenLNS Programmer's Reference 575 • Disconnect • DsRestoreOptions • DsSaveOption • GetDataPoint • MoveToInterface • ToString AddTarget

OpenLNS Programmer's Reference 576 variable connections on a LonWorks network (subject to the constraints of the LonTalk protocol). This is ac

OpenLNS Programmer's Reference 577 connections are created or modified with this method. Availability Local, full, and lightweight clients. Syn

OpenLNS Programmer's Reference 578 options. Availability Local, full, and lightweight clients. Syntax object.DsRestoreOptions Element Descripti

OpenLNS Programmer's Reference 579 Syntax dpObject=networkVariable.DataPoint options Element Description dpObject The DataPoint object returned

OpenLNS Programmer's Reference 580 variable, then the LCA, #119 lcaErrInterfaceNotModifyable exception will be thrown. You can determine if a L

OpenLNS Programmer's Reference 581 • AppDeviceName • AuthenticationConfigFlag • AuthenticationFlag • ChangeableTypeSupport • ClassId • Co

OpenLNS Programmer's Reference 582 Aliases Summary Contains the Aliases collection object associated with the specified NetworkVariable object

OpenLNS Programmer's Reference 25 ClassId Summary Identifies the object class of this object. This property allows the object type to be determ

OpenLNS Programmer's Reference 583 AppDeviceName Summary Returns the name of an application device that contains the network variable. Availabi

OpenLNS Programmer's Reference 584 AuthenticationFlag Summary Returns the network variable’s default authentication setting, which is specified

OpenLNS Programmer's Reference 585 constant, are as follows: 0 lcaNvChangeableTypeNone The network variable’s type cannot be changed. 1 lca

OpenLNS Programmer's Reference 586 cleared, • The configuration property has been set to an invalid value explicitly by your application, or

OpenLNS Programmer's Reference 587 ConfigClassFlag Summary Indicates whether the network variable is a configuration network variable (CPNV).

OpenLNS Programmer's Reference 588 ConfigProperties Summary Contains the ConfigProperties collection object associated with the specified Netwo

OpenLNS Programmer's Reference 589 Added to API Prior to LNS Release 3.0. Description Summary Stores description information about the NetworkV

OpenLNS Programmer's Reference 590 DsFormatType Summary Specifies the type the OpenLNS Server will use in interpreting the value of the network

OpenLNS Programmer's Reference 591 OpenLNS uses the value of the Measurement System field (either U.S. or metric) on this tab to determine the

OpenLNS Programmer's Reference 592 of the program ID, and may be one of the following: 0 - Standard 1 - Device Class 2 - Device Class and Usag

OpenLNS Programmer's Reference 26 property. Index values start at 1. Availability Local, full, lightweight, and independent clients. Note that

OpenLNS Programmer's Reference 593 correct path to the LonMark Device Resource File catalog. After you write to this property, you need to invo

OpenLNS Programmer's Reference 594 was used for pre-LonMark resource files. nvObject The NetworkVariable object to be acted on. Data Type Stri

OpenLNS Programmer's Reference 595 variable’s type, or it is set to the default format for the network variable given the locale settings curre

OpenLNS Programmer's Reference 596 object’s DsPollInterval property. An exception will be raised if you attempt to do so. The System object&apo

OpenLNS Programmer's Reference 597 DsPriority Summary Specifies whether the Data Server polls or updates a network variable using priority mess

OpenLNS Programmer's Reference 598 EstimatedRate Summary The estimated sustained message rate (in tenths of messages per second) declared for t

OpenLNS Programmer's Reference 599 object The NetworkVariable object to be acted on. description The returned functional profile description st

OpenLNS Programmer's Reference 600 on. Data Type String. Read/Write Read-only. Added to API Prior to LNS Release 3.0. ImplementsCp Summary I

OpenLNS Programmer's Reference 601 Syntax index = object.Index Element Description object The object to be acted on. index Index of the netwo

OpenLNS Programmer's Reference 602 implements a configuration property conforming to LonMark interoperability guidelines. FALSE. The network va

OpenLNS Programmer's Reference 27 you can browse a collection to find a particular item by using the _NewEnum property. See the IEnumVARIANT in

OpenLNS Programmer's Reference 603 1 The network variable’s poll attribute on. If the Direction property is set to lcaNvDirectionOutput, th

OpenLNS Programmer's Reference 604 LmNumberManufacturerAssigned Summary Indicates whether the member number within a LonMark object was assigne

OpenLNS Programmer's Reference 605 Syntax indexValue = nvObject.LonMarkMemberIndex Element Description indexValue The index value of the networ

OpenLNS Programmer's Reference 606 Syntax memNumValue = nvObject.LonMarkMemberNumber Element Description memNumValue The member number of the n

OpenLNS Programmer's Reference 607 support changeable types, then the value of the MaxLength property will always match the value of the Length

OpenLNS Programmer's Reference 608 Element Description stringValue The name of the object. object The object to be acted on. Data Type String

OpenLNS Programmer's Reference 609 nvObject The specified NetworkVariable object. Data Type NetworkVariables collection object. Read/Write R

OpenLNS Programmer's Reference 610 desired. Data Type Object. Read/Write Read only. Added to API Depends on the object used to access the prop

OpenLNS Programmer's Reference 611 ConnectDescTemplate object. Availability Local, full, and lightweight clients. Syntax priorityValue = objec

OpenLNS Programmer's Reference 612 ProgrammaticName Summary Returns the programmatic name of the network variable. This property contains the o

OpenLNS Programmer's Reference 28 • ReleasePendingUpdates • Replace • ReplaceEx • ReplaceEx • Reset • ResyncToTemplate • Test • U

OpenLNS Programmer's Reference 613 Selector Summary The network variable selector value assigned to this network variable alias. When a device

OpenLNS Programmer's Reference 614 ServiceType Summary Stores the messaging service to be used for the connection. Note: This property will on

OpenLNS Programmer's Reference 615 acknowledgment messages. Do not use this service type on channels that support altnerate frequencies becaus

OpenLNS Programmer's Reference 616 SnvtId Summary Contains the ID of the standard network variable type (SNVT) used by the network variable. If

OpenLNS Programmer's Reference 617 device associated with the network variable). Availability Local, full, and lightweight clients. Syntax snvt

OpenLNS Programmer's Reference 618 TypeSpec Summary Contains an object that defines the type used by the network variable. This includes the na

OpenLNS Programmer's Reference 619 Accessed Through Connections object. Interface object. LonMarkObject object. Default Property Item Methods

OpenLNS Programmer's Reference 620 unique user names. If you use this method to add a network variable to a collection on a static LonMarkObjec

OpenLNS Programmer's Reference 621 used for updates to the network variable, as well as the network variable’s default polling, synchronization

OpenLNS Programmer's Reference 622 4 lcaNvOptionsPolled Select this option to enable the network variable’s polling attribute. 8 lcaNvOptio

OpenLNS Programmer's Reference 29 • Subnets • Subsystems • Upgrade Requirement Methods The AppDevice object contains the following methods.

OpenLNS Programmer's Reference 623 acted upon was obtained from a LonMarkObject; otherwise, it is ignored. Added to API LNS Release 3.20. Item

OpenLNS Programmer's Reference 624 Syntax retrievedObject = collection.ItemByProgrammaticName progName Element Description retrievedObject The

OpenLNS Programmer's Reference 625 networkVariables The NetworkVariables collection to be acted upon. indexName A Long value specifying the col

OpenLNS Programmer's Reference 626 ClassId Summary Identifies the object class of this object. This property allows the object type to be dete

OpenLNS Programmer's Reference 627 NetworkVariables collection by passing its index (ordinal position) within that collection as the argument f

OpenLNS Programmer's Reference 628 Read/Write Read only. Added to API Depends on the object used to access the property. Generally, this proper

OpenLNS Programmer's Reference 629 CurrentOptions properties of network variable monitor points in temporary monitor sets are not accessible, a

OpenLNS Programmer's Reference 630 • ResetPollingIfUpdated • Retries • ServiceType • SuppressPollingIfBound • ThrottleInterval • UseAs

OpenLNS Programmer's Reference 631 Data Type Integer. Read/Write Read only. Added to API Depends on the object used to access the property. Ge

OpenLNS Programmer's Reference 632 Read/Write Read/write. Added to API LNS Release 3.0. Parent Summary Returns the object that spawned the cur

OpenLNS Programmer's Reference 30 image. Adding an application device to the system is a two-step operation. First, you should define the devi

OpenLNS Programmer's Reference 633 NvOptions property of the MonitorSet object. This may be useful if you want the poll interval for the monit

OpenLNS Programmer's Reference 634 You can set this property through the CurrentOptions property of a permanent or temporary network variable m

OpenLNS Programmer's Reference 635 This is the default. -1 The value is set to the value currently stored in the NvOptions property of the Mo

OpenLNS Programmer's Reference 636 connection, or via a read operation. 0 The polling of the monitor point will continue at the prescribed i

OpenLNS Programmer's Reference 637 DefaultOptions properties of all temporary monitor points are not accessible. However, you can set this prop

OpenLNS Programmer's Reference 638 retryValue The valid values for this property, which are enumerated in the ConstServiceTypes constant, are

OpenLNS Programmer's Reference 639 monOptsObject The NvMonitorOptions object to be acted on. Data Type Long. Read/Write Read/write. Added to

OpenLNS Programmer's Reference 640 Read/Write Read/write. Note: OpenLNS sets this property automatically for message monitor points. For exampl

OpenLNS Programmer's Reference 641 Added to API LNS Release 3.0. UseAsyncSend Summary Determines whether OpenLNS will wait for a completion cod

OpenLNS Programmer's Reference 642 events to confirm that the values of your monitor points have been successfully sent. This approach may be

OpenLNS Programmer's Reference 31 lcaConfigPropOptLoadValues and lcaConfigPropOptLoadUnknown download options when you call DownloadConfigPrope

OpenLNS Programmer's Reference 643 Read/Write Read/write. Note: OpenLNS sets this property automatically for message monitor points. For exampl

OpenLNS Programmer's Reference 644 this set of options should use bound updates. FALSE. The monitor points using this set of options should no

OpenLNS Programmer's Reference 645 • Name • Parent • Tag Events • UpdateErrorEvent • UpdateEvent Methods The NvMonitorPoint contains the f

OpenLNS Programmer's Reference 646 tag An Integer type mpObject The NvMonitorPoint object to be acted on. object An object that implements the

OpenLNS Programmer's Reference 647 doEnable element to True when you open the monitor set. If the doEnable element is set to False, you can als

OpenLNS Programmer's Reference 648 ClassId Summary Identifies the object class of this object. This property allows the object type to be dete

OpenLNS Programmer's Reference 649 demonstrates this procedure: Set curOptions = monPoint.CurrentOptions curOptions.Authentication = True curOp

OpenLNS Programmer's Reference 650 DefaultOptions Summary Contains the default monitoring options that are applied each time the monitor set co

OpenLNS Programmer's Reference 651 Added to API LNS Release 3.0. FormatSpec Summary Contains the format specification information for data rea

OpenLNS Programmer's Reference 652 (.), and colon (:) characters. Availability Local, full, lightweight, and independent clients. Note that so

OpenLNS Programmer's Reference 32 knowing its authentication key, since the device has authentication enabled. If the InitialAuthenticationKey

OpenLNS Programmer's Reference 653 application device that a monitor set belongs to. The Tag properties for all NvMonitorPoint objects in perma

OpenLNS Programmer's Reference 654 UpdateErrorEvent Summary Indicates that a write failure or a poll failure has occurred on the network variab

OpenLNS Programmer's Reference 655 which are contained in the ConstMonitorEventType constant, are as follows: 0 lcaMonitorEventTypeNull This

OpenLNS Programmer's Reference 656 14 lcaMonitorEventTypeMsgCreate A message monitor point has been created. 15 lcaMonitorEventTypeMsgDelete

OpenLNS Programmer's Reference 657 NvMonitorPoints The NvMonitorPoints object contains a collection of NvMonitorPoint objects. This collection

OpenLNS Programmer's Reference 658 automatically removed when the application shuts down. If a monitor point is not going to be used again, rem

OpenLNS Programmer's Reference 659 Remove Summary Removes an NvMonitorPoint object from the collection. This method can only be called when co

OpenLNS Programmer's Reference 660 NvMonitorPoints object in the ConstClassIds constant: 81 lcaClassIdNvMonitorPoints object The object to be

OpenLNS Programmer's Reference 661 retrievedObject The object retrieved from the collection. collObject The collection object to be acted on. i

OpenLNS Programmer's Reference 662 Each ... Next statements. • If you are developing your OpenLNS app in C#, you do not need to use the _NewEn

OpenLNS Programmer’s Reference vii ComponentApps ... 135 Meth

OpenLNS Programmer's Reference 33 lcaMgmtModeDeferConfigUpdates (1). 1 lcaCommissionFlagPropagate Propagates the device’s network image in th

OpenLNS Programmer's Reference 663 • CausesValidation • ClassId • ComponentApps • Container • CurrentFormatLocale • DatabasePath • DragI

OpenLNS Programmer's Reference 664 • OnNetworkVariableStringUpdate • OnNetworkVariableUpdate • OnNodeConnChangeEvent • OnNodeIntfChangeEven

OpenLNS Programmer's Reference 665 AcceptIncomingSession Summary Accepts or rejects an incoming uplink session request after you have registere

OpenLNS Programmer's Reference 666 being opened. TRUE. Suspends all monitor point update events while the uplink session is being opened. In

OpenLNS Programmer's Reference 667 Syntax objServer.AcceptIncomingSession tag, acceptUplink, postponeUpdates Element Description objServer The

OpenLNS Programmer's Reference 668 CompactDb Summary Defragments and re-indexes OpenLNS global database. You may not call this method on an Ope

OpenLNS Programmer's Reference 669 ExtensionByHandle Summary Retrieves an Extension object by its Handle property. This method can be used to r

OpenLNS Programmer's Reference 670 connection update state, remote application transfer state and the Data Server remote-IP mode used by the LN

OpenLNS Programmer's Reference 671 RebuildLdrfCatalog Summary The LonMark Device Resource Files catalog is used to keep track of all sets of Lo

OpenLNS Programmer's Reference 672 method before opening the Object Server if you plan on running your application in the standard licensing mo

OpenLNS Programmer's Reference 34 value that is based on the amount of time it will take for a request message to be sent on the channel, and f

OpenLNS Programmer's Reference 673 Properties The ObjectServer object contains the following properties. • ActiveNetwork • ActiveRemoteNI •

OpenLNS Programmer's Reference 674 Element Description networkObject The Network object designated as active. objServerObject The ObjectServer

OpenLNS Programmer's Reference 675 CausesValidation Summary This is a standard ActiveX control event used for visual controls. This event is n

OpenLNS Programmer's Reference 676 Read/Write Read only. Added to API Prior to LNS Release 3.0. Container Summary This is a standard ActiveX c

OpenLNS Programmer's Reference 677 Data Type String. Read/Write Read/write. Added to API LNS Release 3.20. DatabasePath Summary Contains the

OpenLNS Programmer's Reference 678 extensionsColl The Extensions collection object. object The object whose Extensions collection is being retu

OpenLNS Programmer's Reference 679 connections are updated. You should not set this value to True because your application may then process or

OpenLNS Programmer's Reference 680 Service Device will be automatically upgraded whenever an upgrade is required. If this flag is not set, Open

OpenLNS Programmer's Reference 681 pre-defined FormatLocale objects, and you can create custom FormatLocale objects with the Add method. For mo

OpenLNS Programmer's Reference 682 Element Description isOpenFlag Boolean value. Object A Boolean value indicating whether the ObjectServer ob

OpenLNS Programmer's Reference 35 download Options An Integer value specifying the download options. These values can be ORed together; howev

OpenLNS Programmer's Reference 683 LdrfCatalogPath Summary Obtains the full path for the location of the LonMark device resource file catalog (

OpenLNS Programmer's Reference 684 Availability Local, full, lightweight, and independent clients. Note that some objects that contain this pro

OpenLNS Programmer's Reference 685 Data Type Networks collection object. Read/Write Read only. Added to API Prior to LNS Release 3.0. Object S

OpenLNS Programmer's Reference 686 Added to API Depends on the object used to access the property. Generally, this property exists for an objec

OpenLNS Programmer's Reference 687 RemoteNetworks Summary Contains a collection of all remote full client networks that have been opened by an

OpenLNS Programmer's Reference 688 ResourceLanguageId Summary Controls which language should be used when displaying descriptive type informati

OpenLNS Programmer's Reference 689 TabIndex Summary A standard ActiveX control property used for visual controls. This property is not applica

OpenLNS Programmer's Reference 690 "4.00"). The version number is the same value as that returned in the About Box osObject The Obje

OpenLNS Programmer's Reference 691 WhatsThisHelpID Summary This property returns or sets an associated context number for an object. You can us

OpenLNS Programmer's Reference 692 DragDrop Summary A standard ActiveX control event used for visual controls. This event is not applicable fo

OpenLNS Programmer's Reference 36 to fail. To exclude those configuration properties from a download, you should OR this value with the lcaConf

OpenLNS Programmer's Reference 693 Syntax OnAttachment(networkHandle As Long, systemHandle As Long, objectType as Integer, isAttached As Boolea

OpenLNS Programmer's Reference 694 and NodeId properties. If the state is lcaStateUncnfg or lcaStateCnfgOffline, you can resolve this by recomi

OpenLNS Programmer's Reference 695 constant, are as follows: 0 lcaChangeEventAppDevices 1 lcaChangeEventChannels 2 lcaChangeEventRouters

OpenLNS Programmer's Reference 696 OnCommission Summary Indicates that a device’s commission status has changed. You can register your applica

OpenLNS Programmer's Reference 697 changes. The enumerated values for this element, which are contained in the ConstCommissionStatus constant,

OpenLNS Programmer's Reference 698 OnDbConversionEvent Summary Provides a client application the progress of an OpenLNS database conversion. Wh

OpenLNS Programmer's Reference 699 OnDbValidationEvent Summary Provides a client application the progress of database validation. A database va

OpenLNS Programmer's Reference 700 database validation that is currently being performed. The phase name will be returned as a string of up to

OpenLNS Programmer's Reference 701 Syntax OnIncomingSessionEvent(xDriverProfileName, netName, intfName, tag) Element Description xDriverProfile

OpenLNS Programmer's Reference 702 Syntax OnLonMarkObjectStatusChangeEvent(networkHandle, systemHandle, deviceHandle, LonMarkObjectIndex) Eleme

OpenLNS Programmer's Reference 37 the network. 32 lcaConfigPropOptSetMfgOnlyUnknown Sets all manufacturing only configuration properties to un

OpenLNS Programmer's Reference 703 multi-threading (such as Visual C++), you can receive update events on a separate thread by creating an obje

OpenLNS Programmer's Reference 704 has returned an error. See the OnNvMonitorPointErrorEvent event. 12 lcaMonitorEventTypeNvUpdate A network v

OpenLNS Programmer's Reference 705 OnMsgMonitorPointEvent Summary An event that is generated whenever a message monitor point is created or rem

OpenLNS Programmer's Reference 706 8 lcaMonitorEventTypeNvCreate A network variable monitor point has been created. 9 lcaMonitorEventTypeNv

OpenLNS Programmer's Reference 707 received a request message. 20 lcaMonitorEventTypeMsgResponse A message monitor point has received a repons

OpenLNS Programmer's Reference 708 Added to API LNS Release 3.0. OnNetworkServiceDeviceResetNew Summary Indicates that the local network inter

OpenLNS Programmer's Reference 709 your application's main thread. Instead, a separate thread will be used for this event. When using th

OpenLNS Programmer's Reference 710 Syntax OnNetworkVariableUpdate (monitorTag As Long, value as Variant, dataUpdateInfo As Object) Element De

OpenLNS Programmer's Reference 711 TargetDeviceHandle The Handle of the AppDevice object whose connection changed. Version The version of the d

OpenLNS Programmer's Reference 712 or MessageTag. HubNvMtIndex The Index of the connection’s hub NetworkVariable or MessageTag. Added to API L

OpenLNS Programmer's Reference 38 operations initiated by other flags passed to the DownloadConfigProperties method. However, updates to the de

OpenLNS Programmer's Reference 713 You can also determine the version of an Interface object by reading the Version property. ObjectChangeType

OpenLNS Programmer's Reference 714 affected network variable’s new user name. The user name is stored in the network variable’s Name property.

OpenLNS Programmer's Reference 715 interface. The Name element will contain an empty string. The ObjectIndex element will contain the affecte

OpenLNS Programmer's Reference 716 moved A message tag was removed from the interface. The Name element will contain an empty string. The Obj

OpenLNS Programmer's Reference 717 Name The name of the object that was modified. This may be the user name or the programmatic name of the obj

OpenLNS Programmer's Reference 718 7 lcaMonitorEventTypeMsError This value is not used. 8 lcaMonitorEventTypeNvCreate A network variable m

OpenLNS Programmer's Reference 719 19 lcaMonitorEventTypeMsgRequest A message monitor point has received a request message. 20 lcaMonitorEven

OpenLNS Programmer's Reference 720 This value is not used. 3 lcaMonitorEventTypeRemove This value is not used. 4 lcaMonitorEventTypeMsCreat

OpenLNS Programmer's Reference 721 This value is not used. 17 lcaMonitorEventTypeMsgError A message monitor point has returned an error. See t

OpenLNS Programmer's Reference 722 OnNvMonitorPointUpdateEvent Summary This event is generated whenever a network variable monitor point update

OpenLNS Programmer's Reference 39 send a value on the created monitor point. The device does not need to be commissioned to call this method.

OpenLNS Programmer's Reference 723 This event is also fired each time the state of your client’s NetworkServiceDevice changes from the online

OpenLNS Programmer's Reference 724 been lost, and recovery is either disabled, or it has timed out. Your application will no longer be able to

OpenLNS Programmer's Reference 725 applied to both the OpenLNS database and the physical devices. 1 lcaMgmtModeDeferConfigUpdates Network co

OpenLNS Programmer's Reference 726 Syntax OnSystemNssIdle() Added to API Prior to LNS Release 3.0. OnSystemServicePin Summary Indicates that

OpenLNS Programmer's Reference 727 Validate Summary This is a standard ActiveX control event used for visual controls. This event is not appli

OpenLNS Programmer's Reference 728 • InAlarm • InOverride • InvalidId • InvalidRequest • LockedOut • ManualControl • MechanicalFault •

OpenLNS Programmer's Reference 729 • ResetComplete • SelfTestInProgress • Summary • UnableToMeasure • UnderRange AlarmNotifyDisabled Summa

OpenLNS Programmer's Reference 730 on. Data Type Boolean. Read/Write Read only. Added to API Prior to LNS Release 3.0. ClassId Summary Ident

OpenLNS Programmer's Reference 731 CommFailure Summary Indicates whether there has been a communication failure on the LonMarkObject object, or

OpenLNS Programmer's Reference 732 Disabled Summary Indicates whether the LonMarkObject is currently disabled, or whether the LonMarkObject can

OpenLNS Programmer's Reference 40 Load Summary Loads the application image specified by the AppImagePath property into a device. This method l

OpenLNS Programmer's Reference 733 ElectricalFault Summary Indicates whether an electrical fault has been detected in the LonMarkObject object,

OpenLNS Programmer's Reference 734 FailSelfTest Summary Indicates whether the LonMarkObject passed its most recent self-test, or whether the Lo

OpenLNS Programmer's Reference 735 FeedbackFailure Summary Indicates whether the feedback signal of the LonMarkObject is being received, or whe

OpenLNS Programmer's Reference 736 InAlarm Summary Indicates whether the LonMarkObject is currently in an alarm condition, or whether the LonMa

OpenLNS Programmer's Reference 737 InOverride Summary Indicates whether the LonMarkObject is currently in an override state, or whether the Lon

OpenLNS Programmer's Reference 738 InvalidId Summary Indicates that the requested LonMarkObject does not exist. Availability Local, full, and l

OpenLNS Programmer's Reference 739 been made. statusObject The ObjectStatus object to be acted on. Data Type Boolean. Read/Write Read only. A

OpenLNS Programmer's Reference 740 Data Type Boolean. Read/Write Read only. Added to API Prior to LNS Release 3.0. ManualControl Summary Indi

OpenLNS Programmer's Reference 741 MechanicalFault Summary Indicates whether a mechanical fault has been detected in the LonMarkObject object,

OpenLNS Programmer's Reference 742 ObjectId Summary Contains the ID of the LonMarkObject to which this ObjectStatus object applies. Objects ar

OpenLNS Programmer's Reference 41 application download. The system image used by the device must be compatible with the application image being

OpenLNS Programmer's Reference 743 LonMarkObject object. FALSE. An open circuit has not been discovered. ReportMask Property TRUE. The LonMa

OpenLNS Programmer's Reference 744 TRUE. The LonMarkObject can report that it has exceeded its alarm limits. FALSE. The LonMarkObject can no

OpenLNS Programmer's Reference 745 report that it is inoperable. statusObject The ObjectStatus object to be acted on. Data Type Boolean. Read

OpenLNS Programmer's Reference 746 report that its value is over the acceptable range. statusObject The ObjectStatus object to be acted on. Da

OpenLNS Programmer's Reference 747 failure. Availability Local, full, and lightweight clients. Syntax progFailFlag= statusObject.ProgrammingFai

OpenLNS Programmer's Reference 748 Syntax progModeFlag= statusObject.ProgrammingMode Element Description progModeFlag A Boolean value indicatin

OpenLNS Programmer's Reference 749 can be accessed through the ReportMask property of the LonMarkObject FALSE. The ObjectStatus object represe

OpenLNS Programmer's Reference 750 LonMarkObject has been completed. FALSE. The reset has not been completed. ReportMask Property TRUE. The

OpenLNS Programmer's Reference 751 TRUE. The most recent self-test of the LonMarkObject is still in progress. FALSE. The self-test has been

OpenLNS Programmer's Reference 752 UnableToMeasure Summary Indicates whether an input/output line failure has been detected in the LonMarkObjec

OpenLNS Programmer's Reference 42 LoadEx Summary Loads the application image specified by the AppImagePath property into a device. This method

OpenLNS Programmer's Reference 753 UnderRange Summary Indicates whether the value associated with the LonMarkObject is less than its acceptable

OpenLNS Programmer's Reference 754 Added to API Prior to LNS Release 3.0. PingIntervals The PingIntervals object defines the duration of the p

OpenLNS Programmer's Reference 755 following value is defined for the PingInterval object in the ConstClassIds constant: 69 lcaClassIdPingInt

OpenLNS Programmer's Reference 756 The default value is 60 seconds for private media, and 0 seconds for shared media. piObject The PingInterval

OpenLNS Programmer's Reference 757 The minimum value is 900 seconds. 65535 (-1) means "do not change". piObject The PingIntervals ob

OpenLNS Programmer's Reference 758 tempPing The ping interval (in seconds) for the temporary ping class. Set this property to 0 seconds to disa

OpenLNS Programmer's Reference 759 Methods The RecoveryStatus object does not contain any methods. Properties The RecoveryStatus object contain

OpenLNS Programmer's Reference 760 CurrentPhaseNumber Summary An Integer indicating the current phase of the database recovery process. Availab

OpenLNS Programmer's Reference 761 NumbersPhases Summary The number of phases in the database recovery operation. This value can be used in con

OpenLNS Programmer's Reference 762 Element Description phaseTypeValue The current phase. The phase values, which are contained in the ConstReco

OpenLNS Programmer’s Reference viii BroadcastOptions ... 176 ClassId ...

OpenLNS Programmer's Reference 43 variants. Requires the system image to be stored in flash and to have at least 32K bytes of contiguous flash

OpenLNS Programmer's Reference 763 7 lcaClassIdAppDevice 9 lcaClassIdRouter 18 lcaClassIdConnections 22 lcaClassIdMessageTag 24 lcaClas

OpenLNS Programmer's Reference 764 Syntax progIndicTypeValue = rsObject.ProgressIndicatorType Element Description rsObject The RecoveryStatus o

OpenLNS Programmer's Reference 765 Syntax totalChannelsValue = rsObject.TotalChannels Element Description rsObject The RecoveryStatus object to

OpenLNS Programmer's Reference 766 Data Type Long. Read/Write Read only. Added to API Prior to LNS Release 3.0. TotalRouters Summary The tota

OpenLNS Programmer's Reference 767 • CommissionStatus • Description • Extensions • FarSide • Handle • IconFilePath • InitialAuthenticat

OpenLNS Programmer's Reference 768 device has authentication enabled. If the InitialAuthenticationKey is set prior to commissioning the device

OpenLNS Programmer's Reference 769 (1). 1 lcaCommissionFlagPropagate Propagates the device’s network image in the OpenLNS database to the phy

OpenLNS Programmer's Reference 770 session before using the MoveEx method. This will allow your application to avoid some failure scenarios tha

OpenLNS Programmer's Reference 771 move, this information is lost, and the router will be put online. Added to API Prior to LNS Release 3.0. P

OpenLNS Programmer's Reference 772 PostMove method to move a router while in engineered mode. See the PostMove method for more information on t

OpenLNS Programmer's Reference 44 You first need to invoke it with the lcaMovePrePhysical flag (analogous to the PreMove call), and then once t

OpenLNS Programmer's Reference 773 the same explicit transaction as the invocation of this method. Availability Local, full, and lightweight cl

OpenLNS Programmer's Reference 774 lcaMgmtModePropagateConfigUpdates (0). If the network management mode is set to lcaMgmtModePropagateConfigU

OpenLNS Programmer's Reference 775 normal, and can be expected while the management mode is lcaMgmtModeDeferConfigUpdates (1). These discrepanc

OpenLNS Programmer's Reference 776 subnet/node addressing, but could not communicate with the router using Neuron ID addressing. However, thro

OpenLNS Programmer's Reference 777 could be caused by attaching a new router to the network which was previously configured as part of another

OpenLNS Programmer's Reference 778 match the database. This result will be returned if the router’s domain address has not been configured. 10

OpenLNS Programmer's Reference 779 reconfigured by another network management tool, or the router may be faulty. It may be possible to restore

OpenLNS Programmer's Reference 780 object by calling the System.NetworkServiceRouter.Router.Commission method, and make sure that the State pro

OpenLNS Programmer's Reference 781 Syntax returnValue = object.Count Element Description attachmentStatus The attachment status of the router.

OpenLNS Programmer's Reference 782 Full client remains connected to the server. 3. Set the AuthenticationEnabled property to True the AppDevic

OpenLNS Programmer's Reference 45 PostMove Summary Completes the move of an application device from one channel (or subnet) to another. As part

OpenLNS Programmer's Reference 783 Added to API Prior to LNS Release 3.0. BitmapFilePath Summary Specify the path and file name of a bitmap (*

OpenLNS Programmer's Reference 784 lcaLearningRouter (1) value to this property, it will automatically be converted to lcaConfiguredRouter (0).

OpenLNS Programmer's Reference 785 Syntax commStatusValue = object.CommissionStatus Element Description object The router object to be acted on

OpenLNS Programmer's Reference 786 Data Type String. Read/Write Read/write. Added to API This depends on the object used to access the propert

OpenLNS Programmer's Reference 787 Read/Write Read-only. Added to API Prior to LNS Release 3.0. Handle Summary Contains the handle associated w

OpenLNS Programmer's Reference 788 InitialAuthenticationKey Summary Contains the initial authentication key to be used when commissioning a rou

OpenLNS Programmer's Reference 789 Data Type String (6 bytes). Read/Write Read only. Added to API Prior to LNS Release 3.0. Name Summary Speci

OpenLNS Programmer's Reference 790 Read/Write Read-only. Added to API Prior to LNS Release 3.0. Parent Summary Returns the object that spawned

OpenLNS Programmer's Reference 791 property, OpenLNS will use the default lcaPingClassStationary (3) value. 1 lcaPingClassMobile Class for no

OpenLNS Programmer's Reference 792 properties are read-only. 2 lcaStateUncnfg The application is loaded but the configuration is either not

OpenLNS Programmer's Reference 46 element, and the new subnet as the newSubnetObject element. If this method is called while not attached to th

OpenLNS Programmer's Reference 793 Data Type Integer. Read/Write Read /write. Added to API Prior to LNS Release 3.0. Subsystems Summary Contai

OpenLNS Programmer's Reference 794 Methods The Routers object contains the following methods. • Add • AddEx • AddReference • ItemByHandle •

OpenLNS Programmer's Reference 795 routerType An Integer value indicating the router type. The valid class values, which are contained in the C

OpenLNS Programmer's Reference 796 nearChannel The Channel object for the router's near channel. farChannel The Channel object for the rou

OpenLNS Programmer's Reference 797 network management mode is set to lcaMgmtModePropagateConfigUpdates (0). Added to API Prior to LNS Release

OpenLNS Programmer's Reference 798 Routers collection. coll The Routers collection object. handle A Long value specifying the handle of the Rou

OpenLNS Programmer's Reference 799 the router to be removed. indexName A Long value specifying the collection index of the Router object to rem

OpenLNS Programmer's Reference 800 s (0). Added to API Prior to LNS Release 3.0. Properties The Routers object contains the following properti

OpenLNS Programmer's Reference 801 object The collection object to be acted on. Data Type Long. Read/Write Read only. Added to API Depends on

OpenLNS Programmer's Reference 802 you do not need to use the _NewEnum property because it is automatically used in the implementation of For E

OpenLNS Programmer's Reference 47 lcaErrNsUpdatesDeferred exception will be thrown. In this case, the changes will not be propagated to the dev

OpenLNS Programmer's Reference 803 Methods The RouterSide object contains the following method. • ClearStatus ClearStatus Summary Clears the s

OpenLNS Programmer's Reference 804 The maximum buffer size for a router side is determined when the router's external interface file is im

OpenLNS Programmer's Reference 805 ClassId Summary Identifies the object class of this object. This property allows the object type to be dete

OpenLNS Programmer's Reference 806 LastTestInfo Summary Contains the TestInfo object containing the results of the last time the Test method wa

OpenLNS Programmer's Reference 807 Element Description nodeIdValue The NodeId of the object. object The RouterSide object to be acted on. Dat

OpenLNS Programmer's Reference 808 Data Type String. Read/Write Read only. Added to API LNS Release 3.0. Priority Summary Determines the route

OpenLNS Programmer's Reference 809 the following format: FM:MM:MM:CC:CC:UU:TT:NN Note: You may not use colons when writing the program ID. For

OpenLNS Programmer's Reference 810 properties are read-only. 2 lcaStateUncnfg The application is loaded but the configuration is either not

OpenLNS Programmer's Reference 811 mode). The device's service LED is off in this state. object The RouterSide object to be acted on. Da

OpenLNS Programmer's Reference 812 ServiceStatus A ServiceStatus object contains the status of the current service request for the System objec

OpenLNS Programmer's Reference 48 If you accept an xDriver session with the doPostponeUpdates field set to True, you should open the network in

OpenLNS Programmer's Reference 813 classIdValue The object class of the object. The following value is defined for the ServiceStatus object in

OpenLNS Programmer's Reference 814 QueuePosition Summary Indicates the numbed of transactions that must be started and completed before this se

OpenLNS Programmer's Reference 815 indicates the number of unstarted transactions that must be completed before the service can execute. 1 l

OpenLNS Programmer's Reference 816 The service is unable to execute do to a communications failure. statusValue The status of this service. Da

OpenLNS Programmer's Reference 817 ClassId Summary Identifies the object class of this object. This property allows the object type to be dete

OpenLNS Programmer's Reference 818 Added to API LNS Release 3.0. NodeId Summary Contains the node ID of the device that generated the network v

OpenLNS Programmer's Reference 819 Summary Contains the subnet ID of the device that generated the network variable or message monitor point up

OpenLNS Programmer's Reference 820 Methods The Subnet object does not contain any methods. Properties The Subnet object contains the following

OpenLNS Programmer's Reference 821 Independent clients. Syntax classIdValue = object.ClassId Element Description classIdValue The object class

OpenLNS Programmer's Reference 822 subnetObject The Subnet object. Data Type String. Read/Write Read only. Added to API Prior to LNS Release

OpenLNS Programmer's Reference 49 replacements automatically in most cases. For information on when you might need to manually replace a Networ

OpenLNS Programmer's Reference 823 • Small (16x16) with 16 colors • Monochrome (32x32) • Large (48x48) with 256 colors Added to API Prior t

OpenLNS Programmer's Reference 824 Added to API Depends on the object used to access the property. Generally, this property exists for an objec

OpenLNS Programmer's Reference 825 Methods The Subnets object contains the following methods. • Add • Remove Add Summary Defines a new Subnet

OpenLNS Programmer's Reference 826 Added to API Prior to LNS Release 3.0. Properties The Subnets object contains the following properties: • C

OpenLNS Programmer's Reference 827 object The collection object to be acted on. Data Type Long. Read/Write Read only. Added to API Depends on

OpenLNS Programmer's Reference 828 clients. Syntax parentObject = object.Parent Element Description parentObject The object that is the parent

OpenLNS Programmer's Reference 829 Subsystem The Subsystem object represents a logical grouping of devices and routers. Subsystems may be hier

OpenLNS Programmer's Reference 830 Note: The name of a top-level Subsystem can not be the same as the System object's name. See the Path

OpenLNS Programmer's Reference 831 Syntax appDevicesCollection = object.AppDevices Element Description appDevicesCollection The AppDevices coll

OpenLNS Programmer's Reference 832 Subsystem object in the ConstClassIds constant: 5 lcaClassIdSubsystem object The object to be acted on. D

OpenLNS Programmer's Reference 50 Enter this value if do not want to use any options. 1 lcaReplaceFlagCopy Copies the values of all config

OpenLNS Programmer's Reference 833 Read/Write Read only. Added to API Prior to LNS Release 3.0. Handle Summary Contains the handle associated w

OpenLNS Programmer's Reference 834 Name Summary Specifies the name of an object as a character string. This property is case sensitive. Search

OpenLNS Programmer's Reference 835 Path Summary Contains the full system and subsystem pathname for this subsystem. Pathnames may be used in p

OpenLNS Programmer's Reference 836 Element Description object The Subsystem object to be acted on. routersCollection The Routers collection ret

OpenLNS Programmer's Reference 837 The Subsystems collection accessed through the ALL subsystem contains all objects in the network database, i

OpenLNS Programmer's Reference 838 Syntax subsystemObject = subsystemsColl.Add(subsystemName) Element Description subsystemObject The newly def

OpenLNS Programmer's Reference 839 Properties The Subsystems object contains the following properties: • ClassId • Count • Item • Parent •

OpenLNS Programmer's Reference 840 Data Type Long. Read/Write Read only. Added to API Depends on the object used to access the property. Gener

OpenLNS Programmer's Reference 841 Element Description parentObject The object that is the parent of the specified object. object Any object fo

OpenLNS Programmer's Reference 842 Added to API Prior to LNS Release 3.0. Accessed Through Systems collection object. Default Property Name. Me

OpenLNS Programmer's Reference 51 deconfigured, regardless if this option has been set. This flag should be ORed with lcaReplaceFlagCopy (1).

OpenLNS Programmer's Reference 843 • ClassId • ClientId • CommissionedDeviceCount • ComponentApps • Connections • CurrentAccount • Curre

OpenLNS Programmer's Reference 844 • UninstalledDeviceCount • UpdateInterval Methods The System object contains the following methods: • Be

OpenLNS Programmer's Reference 845 object type. To begin events for device and router attachments, you must call this method twice: once with t

OpenLNS Programmer's Reference 846 object type. Availability Local, full, and lightweight clients. Syntax systemObject.BeginCommissionEvent ob

OpenLNS Programmer's Reference 847 Syntax systemObject.BeginMissedEvent Element Description systemObject The System object to be acted on. Add

OpenLNS Programmer's Reference 848 this element is 0–65,535. Added to API Prior to LNS Release 3.0. BeginServicePinEvent Summary Enables the O

OpenLNS Programmer's Reference 849 validated until the session is ended. The only network operations you can perform within sessions are those

OpenLNS Programmer's Reference 850 CancelTransaction Summary Cancels an active transaction. When a transaction is canceled, either explicitly b

OpenLNS Programmer's Reference 851 engineered system mode). Closing the system does not turn off monitor set monitoring and control. Monitor se

OpenLNS Programmer's Reference 852 discovery process (see the DiscoveryInterval property). Devices do not have to be installed by the OpenLNS

OpenLNS Programmer's Reference 52 Syntax appDevice.ResyncToTemplate options Element Description appDevice The AppDevice object to be re-synced

OpenLNS Programmer's Reference 853 broadcast is used, all deconfigured devices will log a configuration checksum error (CNFG_CS_ERROR = 153) in

OpenLNS Programmer's Reference 854 255 lcaExcludedDevTypeAll None of the above devices will be deconfigured. You can logically OR these constan

OpenLNS Programmer's Reference 855 If a host-based device whose application is not running is installed on the network, OpenLNS may or may not

OpenLNS Programmer's Reference 856 registration is used, an error will cause all device registrations to fail. If registration is done in the

OpenLNS Programmer's Reference 857 This method resynchronizes the network. It should be called every 3 to 5 seconds. This method must be used

OpenLNS Programmer's Reference 858 Added to API Prior to LNS Release 3.0. EndAttachmentEvent Summary Disables the OnAttachmentEvent for a syste

OpenLNS Programmer's Reference 859 Added to API Prior to LNS Release 3.0. EndCommissionEvent Summary Disables the OnCommission event for a syst

OpenLNS Programmer's Reference 860 Added to API Prior to LNS Release 3.0. EndNodeConnChangeEvent Summary Disables the OnNodeConnChangeEvent for

OpenLNS Programmer's Reference 861 This event tag must be the one returned by the BeginServicePinEvent method. Added to API Prior to LNS Relea

OpenLNS Programmer's Reference 862 ExtensionByHandle Summary Retrieves an Extension object by its handle property. Extension records are defin

OpenLNS Programmer’s Reference ix DatabaseValidationErrorInstance ... 207 Methods ...

OpenLNS Programmer's Reference 53 exist on the network, and respond to queries. If the device is installed, it must contain the expected domain

OpenLNS Programmer's Reference 863 of the local client ( for example "192.168.0.3"). Added to API Prior to LNS Release 3.0. GetProgr

OpenLNS Programmer's Reference 864 of the network interface is created. The value of the DomainId property cannot be changed if any devices ha

OpenLNS Programmer's Reference 865 object’s NetworkServiceDevice object to identify the network interface for the new network. 3. Call the Pre

OpenLNS Programmer's Reference 866 Layer 2 network interface, an exception will be thrown. FALSE. OpenLNS will read the domain signature from

OpenLNS Programmer's Reference 867 MgmtMode property will be set to lcaMgmtModeDeferConfigUpdates (1). You will need to set the property to lca

OpenLNS Programmer's Reference 868 lcaRecoveryOptSmallNetwork Assume that the network is a small or medium sized network. This causes database

OpenLNS Programmer's Reference 869 This method cannot be part of an explicit transaction. For more information on explicit transactions, see t

OpenLNS Programmer's Reference 870 The possible values for this parameter, which is contained in the ConstEventSyncModes constant, are as follo

OpenLNS Programmer's Reference 871 requests. You only use this parameter if the mode parameter is set to lcaEventAutoSyncMode. Added to API

OpenLNS Programmer's Reference 872 transactions, see the Using Transactions and Sessions section in the OpenLNS Programmer’s Guide. You can use

OpenLNS Programmer's Reference 54 2 lcaTestResultCommNeuronId The OpenLNS Server was unable to communicate with the device using Neuron ID ad

OpenLNS Programmer's Reference 873 • Description • DiscoveryInterval • DiscoveryLimitedFlag • DomainId • DsPollInterval • DsPriority • D

OpenLNS Programmer's Reference 874 Availability Local, full, and lightweight clients. Syntax acctsCollection = sysObject.Accounts Element Descr

OpenLNS Programmer's Reference 875 Availability Local, full, and lightweight clients. Syntax returnValue = sysObject.ApplicationHandle Element

OpenLNS Programmer's Reference 876 hexadecimal digit of the key. A key of ffff ffff ffff or ffff ffff ffff ffff ffff ffff indicates that authen

OpenLNS Programmer's Reference 877 added to the API. ClientId Summary Contains the ClientId associated with the System object by the Object Se

OpenLNS Programmer's Reference 878 Added to API Prior to LNS Release 3.0. ComponentApps Summary Contains the ComponentApps collection object a

OpenLNS Programmer's Reference 879 Syntax acctObject = systemObject.CurrentAccount Element Description acctObject The current Account object. s

OpenLNS Programmer's Reference 880 Element Description systemObject The System object to be acted on. debugFlag A Boolean value that indicates

OpenLNS Programmer's Reference 881 (4) sets this property to 180 seconds. Availability Local, full, and lightweight clients. Syntax intervalVal

OpenLNS Programmer's Reference 882 FALSE. Device discovery has completed execution without being halted or the application has exited. systemO

OpenLNS Programmer's Reference 55 to be recomissioned or it may be in the middle of a two-phase move. It also might be caused by intermittent

OpenLNS Programmer's Reference 883 5. Use service pin, find, or other manual means of obtaining the actual Neuron ID of each device. 6. Itera

OpenLNS Programmer's Reference 884 developing a remote application that uses shared access mode (meaning that the DsMode property is set to lca

OpenLNS Programmer's Reference 885 priorityFlag The priority flag value. TRUE. The Data Server uses priority messaging to update a network

OpenLNS Programmer's Reference 886 8 0.256 9 0.384 10 0.512 11 0.768 12 1.024 13 1.536 14 2.048 15 3.072 You can write the value 254 to the pro

OpenLNS Programmer's Reference 887 DsRetryCount Summary Sets the maximum number of times to retry messages sent using the request/response, una

OpenLNS Programmer's Reference 888 Read/Write Read/write. Added to API LNS Release 3.20. DsTxTimer Summary Sets the interval between retries f

OpenLNS Programmer's Reference 889 15 3.072 You can write the value 254 to the property at any time to restore it to the default. To set the

OpenLNS Programmer's Reference 890 Syntax fileTransObject = systemObject.FileTransfer Element Description fileTransObject The FileTransfer obje

OpenLNS Programmer's Reference 891 Syntax hostTimerValue = systemObject.HostTimer Element Description hostTimerValue The host timer value in s

OpenLNS Programmer's Reference 892 Disable and PingIntervals properties to 0. Disable automatic service pin registration by setting the system’

OpenLNS Programmer's Reference 56 You can resolve this problem by physically removing the obsolete device. 9 lcaTestResultMismatchSnode The O

OpenLNS Programmer's Reference 893 therefore, your application should set this property before calling the Open method of the System object for

OpenLNS Programmer's Reference 894 invocations. Availability Local, full, and lightweight clients. Syntax lastErrorObject = systemObject.LastE

OpenLNS Programmer's Reference 895 Application available from the Echelon OpenLNS Utilities program folder. Data Type Boolean. Read/Write Read

OpenLNS Programmer's Reference 896 LdrfLanguages Summary Contains the LdrfLanguages collection representing the languages known by OpenLNS. You

OpenLNS Programmer's Reference 897 modeType The Object Server management mode. The enumerated values for this parameter, which are contained in

OpenLNS Programmer's Reference 898 Name Summary Specifies the name of an object as a character string. This property is case sensitive. Search

OpenLNS Programmer's Reference 899 Data Type NetworkResources object. Read/Write Read only. Added to API LNS Release 3.20. NetworkServiceDevic

OpenLNS Programmer's Reference 900 Added to API Prior to LNS Release 3.0. Parent Summary Returns the object that spawned the current child obje

OpenLNS Programmer's Reference 901 permission value given by the first matching spec. This feature may be used to implement sophisticated perm

OpenLNS Programmer's Reference 902 specified System object. The RecoveryStatus object provides status information on how a database recovery is

OpenLNS Programmer's Reference 57 Neuron ID addressing and subnet/node addressing. However, the device has network management authentication e

OpenLNS Programmer's Reference 903 invoked. This property defaults to True if the InstallOptions property was set to lcaSharedMedia (2) before

OpenLNS Programmer's Reference 904 RepeatTimer Summary Sets the repeat timer value that will be used on the system for network management messa

OpenLNS Programmer's Reference 905 Syntax repeatTimerValue = object.RepeatTimer Element Description repeatTimerValue The encoded value of the

OpenLNS Programmer's Reference 906 ResourceLanguageId Summary Controls which language should be used when displaying descriptive type informati

OpenLNS Programmer's Reference 907 RetryCount Summary Sets the retry count used by the Object Server (and connections that use the default Syst

OpenLNS Programmer's Reference 908 TRUE is commissioned or replaced. 1 lcaSecurityLevelKeyDistribution Disabled Keys are never distributed ov

OpenLNS Programmer's Reference 909 State Summary Describes the state of the system. Availability Local, full, and lightweight clients. Syntax

OpenLNS Programmer's Reference 910 Application loaded but not running. The configuration is considered valid in this state; the network manage

OpenLNS Programmer's Reference 911 Subsystems Summary Contains the Subsystems collection object associated with the specified System. A Subsys

OpenLNS Programmer's Reference 912 systemObject The System object to be acted on. Data Type TemplateLibrary object. Read/Write Read only. Add

OpenLNS Programmer's Reference 58 17 lcaTestResultInterfaceNotOnline The OpenLNS network interface that the OpenLNS Server is attempting to u

OpenLNS Programmer's Reference 913 5 0.096 6 0.128 7 0.192 8 0.256 9 0.384 10 0.512 11 0.768 12 1.024 13 1.536 14 2.048 15 3.072 You can also w

OpenLNS Programmer's Reference 914 UninstalledDeviceCount Summary Returns the number of devices uninstalled by network recovery. At the comple

OpenLNS Programmer's Reference 915 UpdateInterval Summary The rate (in seconds) at which the background database device image reconciliation pr

OpenLNS Programmer's Reference 916 Systems The Systems object represents a collection of System objects. Each Systems collection contains a sin

OpenLNS Programmer's Reference 917 3 lcaClassIdSystem object The object to be acted on. Data Type Integer. Read/Write Read only. Added to A

OpenLNS Programmer's Reference 918 on. index A Long type specifying the ordinal index of the System object to be retrieved. stringExpression A

OpenLNS Programmer's Reference 919 • If you are developing your OpenLNS app in C#, you do not need to use the _NewEnum property explicitly bec

OpenLNS Programmer's Reference 920 ClassId Summary Identifies the object class of this object. This property allows the object type to be dete

OpenLNS Programmer's Reference 921 Availability Local, full, lightweight, and independent clients. Note that some collections are not available

OpenLNS Programmer's Reference 922 specified object. object Any object for which the parent is desired. Data Type Object. Read/Write Read only

OpenLNS Programmer's Reference 59 The UpgradeStatus object returned by this method contains information indicating whether or not the upgrade

OpenLNS Programmer's Reference 923 • ActualProgramId • ActualSubnetId • AuxResultData • ClassId • DetailInfo • ExpectedDomainId • Ex

OpenLNS Programmer's Reference 924 Availability Local, full, and lightweight clients. Syntax neuronIdValue = toObject.ActualNeuronId Element D

OpenLNS Programmer's Reference 925 Availability Local, full, and lightweight clients. Syntax progIdValue = toObject.ActualProgramId Element De

OpenLNS Programmer's Reference 926 are as follows: 0 lcaNoAuxData There is no useful information in the Actual/Expected properties of the Las

OpenLNS Programmer's Reference 927 constant: 71 lcaClassIdTestInfo object The object to be acted on. Data Type Integer. Read/Write Read onl

OpenLNS Programmer's Reference 928 Availability Local, full, and lightweight clients. Syntax domainIdValue = toObject.AuxResultData Element D

OpenLNS Programmer's Reference 929 Syntax nodeIdValue = toObject.ExpectedNodeId Element Description toObject The TestInfo object to be acted on

OpenLNS Programmer's Reference 930 Syntax subnetIdValue = toObject.ExpectedSubnetId Element Description toObject The TestInfo object to be acte

OpenLNS Programmer's Reference 931 specified object. object Any object for which the parent is desired. Data Type Object. Read/Write Read only

OpenLNS Programmer's Reference 932 The OpenLNS Server was able to communicate with the device using subnet/node addressing, but could not commu

OpenLNS Programmer's Reference 60 Echelon recommends that you upgrade the device before loading the application image. This will allow you to v

OpenLNS Programmer's Reference 933 caused by attaching a new device to the network which was previously configured as part of another network o

OpenLNS Programmer's Reference 934 10 lcaTestResultNoNeuronId The device has not been assigned a Neuron ID. 11 lcaTestResultMismatchProgram

OpenLNS Programmer's Reference 935 communicate with the device using both Neuron ID addressing and subnet/node addressing. However, the device

OpenLNS Programmer's Reference 936 The OpenLNS network interface that the OpenLNS Server is attempting to use is not property configured. Recom

OpenLNS Programmer's Reference 937 Methods • Lookup Properties • ClassId • Index • IsComplete • Length • ObjectType • Parent • Progr

OpenLNS Programmer's Reference 938 Element Description classIdValue The object class of the object. The following value is defined for the Typ

OpenLNS Programmer's Reference 939 • TRUE. The TypeSpec object is complete. • FALSE. The TypeSpec object is incomplete. Several conditions

OpenLNS Programmer's Reference 940 ObjectType Summary Indicates the type of objects to which the type should be applied. When new values are wr

OpenLNS Programmer's Reference 941 parentObject The object that is the parent of the specified object. object Any object for which the parent i

OpenLNS Programmer's Reference 942 Scope Summary Each TypeSpec object references a type defined in a LonMark resource file. This property indic

OpenLNS Programmer's Reference 61 UploadConfigProperties method can be invoked using either the AppDevice object or the Interface object. You

OpenLNS Programmer's Reference 943 lcaResourceScopeAutoDetermination This value applies to the Mode property of LonMarkObject objects only. Se

OpenLNS Programmer's Reference 944 UpgradeInfo Each time you call the Upgrade method to upgrade an AppDevice object’s external interface file,

OpenLNS Programmer's Reference 945 • Reason • Status • ToIndex • ToOwnerIndex Class Summary Indicates the type of external interface compo

OpenLNS Programmer's Reference 946 9 lcaUgClsDynamicMessageTag A dynamic MessageTag. uiObject The UpgradeInfo object to be acted on. Data Ty

OpenLNS Programmer's Reference 947 configuration property. If the configuration property is contained by a LonMarkObject or network variable,

OpenLNS Programmer's Reference 948 Parent Summary Returns the object that spawned the current child object. The parent object is determined by

OpenLNS Programmer's Reference 949 components can not be matched if their types differ. 2 lcaUgRsName The external interface component was pr

OpenLNS Programmer's Reference 950 name used for these custom interfaces is "LcaUpgrade<n>", where <n> is a sequential nu

OpenLNS Programmer's Reference 951 Status Summary Indicates whether the external interface component represented by the UpgradeInfo object was

OpenLNS Programmer's Reference 952 any configuration property values will be preserved. 4 lcaUgStsRelocated The external interface component

OpenLNS Programmer's Reference 62 this case, only values that are unknown in the OpenLNS database will be uploaded from the physical device. Fo

OpenLNS Programmer's Reference 953 ToIndex Summary Returns the device index value assigned to the external interface component after the upgrad

OpenLNS Programmer's Reference 954 property that is contained within a LonMarkObject or network variable, but the Status property is set to lca

OpenLNS Programmer's Reference 955 ClassId Summary Identifies the object class of this object. This property allows the object type to be dete

OpenLNS Programmer's Reference 956 collection by passing its index (ordinal position) within that collection as the argument for the Item prope

OpenLNS Programmer's Reference 957 added to the API. _NewEnum Summary Enables you to iterate over the objects in a collection using For Each ..

OpenLNS Programmer's Reference 958 • Sequence • UpgradInfos Methods The UpgradeStatus object does not contain any methods. Properties The Upg

OpenLNS Programmer's Reference 959 clients. Syntax parentObject = object.Parent Element Description parentObject The object that is the parent

OpenLNS Programmer's Reference 960 usObject The UpgradeStatus object to be acted on. Data Type Integer. Read/Write Read/write. Added to API LN

OpenLNS Programmer's Reference 961 Syntax ioColl = uiObject.UpgradeInfos Element Description uiColl The UpgradeInfos collection to be returned.

OpenLNS Programmer's Reference 962