File.ReadString Method

Reads a UTF8 or ANSI string from a file.

int ReadString(char[] buffer, int max_size, int read_count)

Parameters

char[] buffer

Buffer to store the string.

int max_size

Maximum size of the string buffer.

int read_count

If -1, reads until a null terminator is encountered in the file. Otherwise, read_count bytes are read into the buffer provided. In this case the buffer is not explicitly null terminated, and the buffer will contain any null terminators read from the file.

Return Value

Number of characters written to the buffer, or -1 if an error was encountered.

Errors

read_count > max_size.