ReadStringFromStream Function

Reads a string value from a stream implementation.

Pascal

function ReadStringFromStream(
    AStream: TIdStream; 
    ASize: Integer = -1
): string;

Parameters

Parameters	Description
AStream	Source of values for the read operation.
ASize	Number of bytes in the stream to be read. Default value is -1.

Returns

String - Value read from the stream.

Description

ReadStringFromStream is a String function used to read a String value from a Stream. ReadStringFromStream isolates the differences between platform- or operating system-specific stream implementations required to perform the operation.

AStream is the stream used as the source of values for the read operation.

ASize is the size of the stream used as input for the read operation.

The return value for the function is a string containing the values read from the stream, or an empty string when ASize contains 0 (zero).

Use ReadBytesArrayFromStream to read an array of Byte values from a stream implementation.

Use ReadStringFromStream to read a string data type from a stream implementation.