Skip to main content

​
fileGetString

Open topic with navigation CAPL Functions » General » Function Overview » fileGetString Valid for: CANoe DE • CANoe:lite DE • CANoe4SW DE • CANoe4SW:lite DE

​
Function Syntax

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

​
Method Syntax (Dynamic)

Method Syntax 
long File::GetString(char buff[], long buffsize);

​
Description

The function reads a string from the specified file into the buffer buff. Characters are read until the end of line is reached or the number of read characters is equal to buffsize -1. The end of line is marked either
  • by a single line feed or
  • a carriage return and a line feed (DOS file)
The end of line in the buffer is represented by a line feed. See also fileGetStringSZ. If the end of a line was encountered, the returned string contains a new line character. Else, the next call to fileGetString will start reading in the last line starting with the first character which didn’t fit into the buffer on the previous call.

​
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

See File Functions Class: File