beautypg.com

Rxtimeout, Startposition – Echelon OpenLNS User Manual

Page 362

background image

OpenLNS Programmer's Reference

325

A value of 0 indicates that the number

of retries will be calculated based on

the network topology. The default

value is 0.

object

The

FileTransfer

object to be acted on.

Data Type

Integer.

Read/Write

Read/write.

Added to API

Prior to LNS Release 3.0.

RxTimeOut

Summary

Specifies the receive timeout value used for file transfer

messages

.

Availability

Local, full, and lightweight clients.

Syntax

timeoutValue = fileTransObject.RxTimeOut

Element

Description

timeoutValue

The returned receive timeout value in

milliseconds (0–65,535).
The file is automatically closed, and

an exception will be thrown, if no file

transfer messages are received during

the specified interval.
The default value is 0, which means

that the timeout is calculated based

on the network topology.

fileTransObject

The

FileTransfer

object to be acted on.

Data Type

Integer.

Read/Write

Read/write.

Added to API

Prior to LNS Release 3.0.

StartPosition

Summary

Specifies the position of the file pointer for a random access

file operation

.

Availability

Local, full, and lightweight clients.

Syntax

positionValue = fileTransObject.

StartPosition

Element

Description

positionValue

The start position value.
A start position of 0 specifies

sequential file access.
A non-zero value causes a seek

operation to be performed before

executing the read or write.