Skip to main content
Open topic with navigation CAPL Functions » General » Function Overview » fileGetStringSZ

​
fileGetStringSZ

Valid for: CANoe DE • CANoe:lite DE • CANoe4SW DE • CANoe4SW:lite DE

​
Function Syntax

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

​
Method Syntax (Dynamic)

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

​
Description

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 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)
No line feed character will be contained in the buffer. See also fileGetString.

​
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