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

kdu_cache::get_databin_length

Java: Kdu_cache::Get_databin_length

virtual int get_databin_length( int databin_class, kdu_long codestream_id, kdu_long databin_id, bool * is_complete=NULL)

Java: int Get_databin_length( int databin_class, long codestream_id, long databin_id, boolean[] is_complete)

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

Go to class description.


Synopsis

Returns the total number of initial bytes which have been cached for a particular data-bin. See add_to_databin for an explanation of data-bin classes and identifiers.


Return Value

If the data-bin has multiple contiguous ranges of bytes, with intervening holes, the function returns the length only of the contiguous range of bytes which commences at byte 0.

Arguments

databin_class [int]

codestream_id [kdu_long]

databin_id [kdu_long]

is_complete [bool *]

If non-NULL, this argument is used to return a value indicating whether or not the cached representation of the indicated data-bin is complete. For this, the representation must have non holes and the is_final flag must have been asserted in a previous call to add_to_databin.


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