Setrawvaluesex – Echelon OpenLNS User Manual

Page 186

Advertising
background image

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

configuration property.
You can specify configuration property values as either a byte

array or a Variant containing a byte array (MFC type

VT_UI1 | VT_ARRAY). The application is responsible for

creating the raw byte array that corresponds to the desired

configuration property values.

Availability

Local, full, and lightweight clients.

Syntax

cpObject.

SetRawValuesEx

index, count, array, options

Element

Description

cpObject

The

ConfigProperty

object to be acted on.

index

Specify the first element in the array to

write to.
If you specify an invalid index, an LCA,

#90 lcaValueOutOfRange exception is

thrown.

count

Specify the number of elements to write to.
If this number exceeds the value of the

ConfigProperty

object’s

Dimension

property,

an LCA, #90 lcaValueOutOfRange

exception is thrown.

array

A

Variant

containing the raw values to be

written to the

ConfigProperty

object.

options

Use this element to determine whether

OpenLNS will write new raw values of the

ConfigProperty

array elements to the

OpenLNS database or to the physical

application device.
The possible values for this element, which

are stored in the

ConstDataSourceOptions

constant, are as follows:
0 lcaDataSourceOptionsNormal
Writes the raw value array to the physical

device

.

2

lcaDataSourceOptionsDatabaseOnly
Writes the raw value array to the OpenLNS

database.
Calling the

SetRawValuesEx

method with

this option set is recommended only to

update the database with a value that has

Advertising