istream_length()

`istream_length()`#

Retrieves the length of unread data currently available in the internal gbuffer of the specified istream.

C

Prototype

PUBLIC size_t istream_length(
    istream_h   istream
);

Parameters

Key	Type	Description
`istream`	`istream_h`	The handle to the istream whose unread data length is to be retrieved.

Return Value

Returns the number of unread bytes in the internal gbuffer.

Notes

If the istream is NULL, the function logs an error and returns 0.
This function provides the size of the data available for reading without modifying the read or write pointers.

JS

Prototype

// Not applicable in JS

Python

Prototype

# Not applicable in Python