TIpClient() > File handling

oTIpClient:readToFile()

Reads data from the internet connection to a local file.

Syntax

:readToFile( <cFileName>, [<nFileAttr>], <nBytes> ) --> lSuccess

Arguments

<cFileName>

This is a character string holding the name of the file to create. It must include path and file extension. If the path is omitted from <cFileName>, the file is created in the current directory.

<nFileAttr>

A numeric value specifying one or more attributes associated with the new file. #define constants from the FILEIO.CH file can be used for <nFileAttr> as listed in the table below:

Attributes for binary file creation

Constant	Value	Attribute	Description
FC_NORMAL *)	0	Normal	Creates a normal read/write file
FC_READONLY	1	Read-only	Creates a read-only file
FC_HIDDEN	2	Hidden	Creates a hidden file
FC_SYSTEM	4	System	Creates a system file
*) default attribute

<nBytes>

The number of bytes to retrieve from the server must be specified as a numeric value.

Description

Method :readToFile() transmits the specified number of bytes from the server to the local station and writes them into the file <cFileName>. Note that reading data requires a successful call to the :open() method for establishing the internet connection.

The method returns a logical value indicating success of the operation.