CAPL Script

OpenFileRead

Note A filename must be passed to this function. The absolute filename is determined by means of asearch procedure. First a search is made to determine whether the given file is located in a directory of the databases. If the desired file is not found the active configuration directory is used.

Syntax

dword openFileRead (char filename[], dword mode); // form 1

dword openFileRead (char filename[], dword mode, dword fileEncoding); // form 2

Function

This function opens the file namedfilenamefor the read access. If mode=0 the file is opened in text mode;if mode=1 the file is opened in binary mode.

Parameters

filename file name

mode

fileEncoding

Identifier of theMicrosoftcode page that is used to encode the file.

Return Values

The return value is the file handle that must be used for read operations. If an error occurs, the return value is 0.

Example