| synopsis || return value || prev || next |

jp2_input_box::get_remaining_bytes

Java: Jp2_input_box::Get_remaining_bytes

kdu_long get_remaining_bytes( )

Java: long Get_remaining_bytes( )

[Declared in "../apps/compressed_io/jp2.h"]

Go to class description.


Synopsis

Returns the number of bytes in the box's contents which lie beyond the current read pointer. Adding this value to that returned by get_pos yields the box's total length. However, if the box's length cannot be determined a priori, this function will return a negative value.

The behaviour of the function is undefined if the box is not open.


Return Value

Returns -1 if the box has a rubber length, meaning that its length field indicated that the box extends to the end of the JP2 source. This return value will be converted to a non-negative value once the end of the box is actually encountered by attempting to read or seek past it.


| top || synopsis || return value || prev || next |