H5garbage_collect

fnherr_t H5garbage_collect()

Garbage collects on all free-lists of all types.

H5garbage_collect walks through all garbage collection routines of the library, freeing any unused memory.

It is not required that H5garbage_collect be called at any particular time; it is only necessary for certain situations where the application has performed actions that cause the library to allocate many objects. The application should call H5garbage_collect if it eventually releases those objects and wants to reduce the memory used by the library from the peak usage required.

Returns

Returns a non-negative value if successful;

otherwise returns a negative value.