Fileindex – Echelon OpenLNS User Manual

Page 357

Advertising
background image

OpenLNS Programmer's Reference

320

FileIndex

Summary

Specifies the file index to be used during operations on the

FileTransfer

object

.

Note: OpenLNS does not support writing to the template file

or the value file (or value files) because it would corrupt the

configuration properties. Instead, OpenLNS provides the

ConfigProperties object to provide transparent access to

configuration properties implemented via configuration

network variables, file transfer, and direct memory

read/write. OpenLNS applications must use the

ConfigProperties objects in place of direct file transfer when

writing or reading configuration properties.

Availability

Local, full, and lightweight clients.

Syntax

indexValue = fileTransObject.

FileIndex

Element

Description

indexValue

The file index to read or write.

The file index may have a value

between 0–65,535. The default value

is 2.

For a write, the value is the index

on the receivers.

For a read, the value is the index

on the sender.

The file index property should be set

before any of the FileTransfer object

methods are invoked.

LonMark

compliant devices may

implement standard configuration

property types (SCPTs) using the

LonMark file transfer protocol. In

this case, file indexes 0 and 1 are

reserved for the SCPT template and

value files. Index 2 may be used for

the constant value file.

fileTransObject

The

FileTransfer

object to be acted on.

Data Type

Integer.

Read/Write

Read/write.

Added to API

Prior to LNS Release 3.0.

Advertising