| synopsis || return value || prev || next |
virtual bool close( )
Java: boolean Close( )
[Declared in "../coresys/common/kdu_compressed.h"]
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 targets, in which case there is no need to override this function in the relevant derived class.
The return value has no meaning to Kakadu's code-stream management machinery, but derived objects may use the return value to signal whether or not an output device was able to consume all of the written data. It may happen that write returns true because the data had to be buffered, but that upon calling close it was found that not all of the buffered data could actually be transferred to the ultimate output device.
| top || synopsis || return value || prev || next |