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

kdu_compressed_source::close

Java: Kdu_compressed_source::Close

virtual bool close( )

Java: boolean Close( )

[Declared in "../coresys/common/kdu_compressed.h"]

Go to class description.


Synopsis

This particular function does nothing, but its presence as a virtual function ensures that a more derived object's close function can be invoked from the abstract base object. Closure might not have meaning for some types of sources, in which case there is no need to override this function in the relevant derived class.


Return Value

The return value has no meaning to Kakadu's code-stream management machinery, but derived objects may choose to return false if not all of the available data was consumed. See jp2_input_box::close for an example of this.


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