Removes an ID from internal storage
Procedure:
H5I_REMOVE_VERIFY(id, type)
Signature:
void *H5Iremove_verify( hid_t id, H5I_type_t id_type )
Parameters:
hid_t id | IN: The ID to be removed from internal storage |
H5I_type_t type | IN: The identifier of the type whose reference count is to be retrieved |
Description:
H5I_REMOVE_VERIFY first ensures that id belongs to id_type. If so, it removes id from internal storage and returns the pointer to the memory it referred to. This pointer is the same pointer that was placed in storage by H5I_REGISTER. If id does not belong to id_type, then NULL is returned.
The id parameter is the ID which is to be removed from internal storage. Note: this function does NOT deallocate the memory that id refers to. The pointer returned by H5I_REGISTER must be deallocated by the user to avoid memory leaks.
The type parameter is the identifier for the ID type which id is supposed to belong to. This identifier must have been created by a call to H5I_REGISTER_TYPE.
Returns:
Returns a pointer to the memory referred to by id on success, NULL on failure.
Example:
--- Last Modified: May 24, 2018 | 04:15 PM
