CAPL Script

FileGetStringSZ

Syntax

long fileGetStringSZ(char buff[], long buffsize, dword fileHandle);

Method(Dynamic)

long File::GetStringSZ(char buff[], long buffsize);

Function

The function reads a string from the specified file. Characters are read until the end of line is reached or the number of read characters is equal tobuffsize-1.The end of line is marked either No line feed character will be contained in the buffer. See alsofileGetString.

Parameters

buff Buffer for the read-out string

buffsize

Length of the string

fileHandle

Handle to the file

Return Values

If an error occurs, the return value is 0, else 1.

Example

Class: File