Skip to main content

HDF5UnlinkObject

HDF5UnlinkObject [ /Z ] locationID, nameStr​

The HDF5UnlinkObject operation unlinks the specified object (a group, dataset, datatype or link) from the HDF5 file.

Unlinking an object deletes the object from the file's hierarchy but does not free up the space in the file used by the object. The HDF Group provides a command-line utility program, h5repack, to compact HDF5 files.

If you have opened a group via HDF5CreateGroup or HDF5OpenGroup, you should close it via HDF5CloseGroup before calling HDF5UnlinkObject.

Parameters​

locationID is an HDF5 file ID number obtained from HDF5CreateFile or HDF5OpenFile or an HDF5 group ID obtained from HDF5CreateGroup or HDF5OpenGroup. If locationID is invalid an error is returned.

nameStr is a string containing the HDF5 path to the object to be unlinked.

Flags​

/ZSuppress error generation. Use this if you want to handle errors yourself.

Output Variables​

HDF5UnlinkObject sets the following output variable:

V_FlagSet to zero if the operation succeeds, non-zero if it fails.

See Also​

HDF5CreateLink