Documentation Center

  • Trial Software
  • Product Updates

Contents

H5P.get_gc_references

Garbage collection references setting

Syntax

gc_ref = H5P.get_gc_references(fapl_id)

Description

gc_ref = H5P.get_gc_references(fapl_id) returns the current setting for the garbage collection references property from the file access property list specified by fapl_id. If gc_ref is 1, garbage collection is on; if 0, garbage collection is off.

Examples

fid = H5F.open('example.h5');
fapl = H5F.get_access_plist(fid);
gc_ref = H5P.get_gc_references(fapl);
H5P.close(fapl);
H5F.close(fid);

See Also

Was this topic helpful?