read

Reads a chunk of data from the stream.

Reads and returns the specified number of characters, or fewer if the end of stream is reached. Throws a SUPStreamNotOpenException if the stream is not open for reading.

Syntax

- (SUPNullableBinary)read :(SUPLong)length;

Parameters

length – The maximum number of characters to be read into the chunk.

Returns

read returns a chunk of string data read from the stream, or a null value if the end of the stream has been reached.

Examples

– Reads in the biography file.
int64_t bufferLength = 1024; NSString *something = [text read:bufferLength]; // null if EOF while (something != nil) { something = [text read:bufferLength]; }