Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5P_REMOVE

Removes a property from a property list

Procedure:

H5P_REMOVE (  plid, name )

Signature:

herr_t H5Premove(
                  hid_t plid;
                  const char *name
		)
  

Fortran90 Interface: h5premove_f
    
SUBROUTINE h5premove_f(plid, name, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: plid   ! Property list identifier
  CHARACTER(LEN=*), INTENT(IN) :: name ! Name of property to remove
  INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                       ! 0 on success and -1 on failure
END SUBROUTINE h5premove_f
	

Parameters:
hid_t plidIN: Identifier of the property list to modify
const char *name    IN: Name of property to remove

Description:

H5P_REMOVE removes a property from a property list.

Both properties which were in existence when the property list was created (i.e. properties registered with H5P_REGISTER) and properties added to the list after it was created (i.e. added with H5P_INSERT1) may be removed from a property list. Properties do not need to be removed from a property list before the list itself is closed; they will be released automatically when H5P_CLOSE is called.

If a close callback exists for the removed property, it will be called before the property is released.

Returns:

Success: a non-negative value

Failure: a negative value

Example:

Coming Soon!

History:

 

--- Last Modified: January 09, 2018 | 12:39 PM