istream_length()

istream_length()#

istream_length() returns the number of unread bytes in the internal buffer of the given input stream.

Prototype

PUBLIC size_t istream_length(
    istream_h istream
);

Parameters

Key

Type

Description

istream

istream_h

Handle to the input stream whose unread byte count is to be retrieved.


Return Value

Returns the number of unread bytes in the internal buffer of the input stream.

Notes

[‘If istream is NULL, an error is logged, and the function returns 0.’, ‘This function is useful for checking how much data remains to be read from the stream.’]

Prototype

// Not applicable in JS

Prototype

# Not applicable in Python
Examples
// TODO C examples
// TODO JS examples
# TODO Python examples