Fileinfo, Filesize – Echelon OpenLNS User Manual

Page 358

Advertising
background image

OpenLNS Programmer's Reference

321

FileInfo

Summary

Returns a 16-byte string describing any of the files on the

app devices that have been added to the FileTransfer object’s

target list.
The FileTransfer object has a list of targets, numbered from

one to n. The nTarget element is an index within that list,

which is used to get the node handle of the app device for

which a file description is to be obtained. If the nTarget

value is out of range, an exception is thrown.
The app device identified by the nTarget element may have

multiple files. This property will return the file description of

the file that is using the value assigned to the FileIndex

property as its index number.

Availability

Local, full, and lightweight clients.

Syntax

szFileInfoValue =

fileTransObject

.FileInfo (nTarget)

Element

Description

szFileInfoValue

The file description

.

fileTransObject

The

FileTransfer

object to be acted on.

nTarget

The FileTransfer object index

Data Type

String.

Read/Write

Read-only.

Added to API

Prior to LNS Release 3.0.

FileSize

Summary

Returns the file size of any of the files on the app devices that

have been added to the

FileTransfer

object’s target list, in

bytes (up to 4 GB)

.

Availability

Local, full, and lightweight clients.

Syntax

nFileSizeValue = ftObject.

FileSize

(nTarget)

Element

Description

nFileSizeValue

The file size.

ftObject

The

FileTransfer

object to be acted on.

nTarget

The

FileTransfer

object index.

The FileTransfer object has a list of

targets, numbered from one to N.

nTarget is an index within that list,

used to get the node handle of the app

device for which the file size is to be

obtained. If the nTarget value is out

of range, an exception will be thrown.
The app device identified by the

nTarget element may have multiple

Advertising