Readbufferlength, Retrycount, D readbufferlength – Echelon OpenLNS User Manual

Page 361

Advertising
background image

OpenLNS Programmer's Reference

324

Syntax

priorityFlag = fileTransObject.PriorityFlag

Element

Description

priorityFlag

The returned priority flag, which is a

Boolean value.
TRUE. Priority messaging is used

.

FALSE. Priority messaging is not

used

.

fileTransObject

The

FileTransfer

object to be acted on.

Data Type

Boolean.

Read/Write

Read/write.

Added to API

Prior to LNS Release 3.0.

ReadBufferLength

Summary

Specifies the read buffer length for file transfer

.

When reading data from a file on a device, this property

allows the application to specify how many bytes to read, and

how large to make the return value from the

ReadFile

method. For the

ReadFile

method, the size of the returned

array, will be the

ReadBufferLength

multiplied by the

number of target devices

Availability

Local, full, and lightweight clients.

Syntax

bufferSize = fileTransObject.

ReadBufferLength

Element

Description

bufferSize

The read buffer length.

fileTransObject

The

FileTransfer

object to be acted on.

Data Type

Long.

Read/Write

Read/write.

Added to API

Prior to LNS Release 3.0.

RetryCount

Summary

Sets the

maximum number of retries used by the sender

during the request/response phase of the file transfer

protocol

.

Availability

Local, full, and lightweight clients.

Syntax

retryCountValue = object.RetryCount

Element

Description

retryCountValue

The retry count value.
This value does not affect the retry

count used by the initiator during

setup.

Advertising