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

kdu_cache::mark_databin

Java: Kdu_cache::Mark_databin

virtual bool mark_databin( int databin_class, kdu_long codestream_id, kdu_long databin_id, bool mark_state)

Java: boolean Mark_databin( int databin_class, long codestream_id, long databin_id, boolean mark_state)

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

Go to class description.


Synopsis

This function provides a convenient service which may be used by client applications or derived objects for marking data-bins. The interpretation of a mark is not defined here, but the service is expected to be used to record whether or not the server has already been informed regarding the existing contents of the data-bin. Note carefully that data-bins which do not already exist will NOT be created in order to be marked.

See add_to_databin for an explanation of data-bin classes and identifiers.


Return Value

True if the data-bin was already marked; false otherwise. Data-bins which are not present in the cache are considered unmarked.

Arguments

databin_class [int]

codestream_id [kdu_long]

databin_id [kdu_long]

mark_state [bool]

If true, the function causes the data-bin to be marked; otherwise, the function causes the data-bin to become unmarked.


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