Last modified: 15 June 2009
Name: H5Iis_valid
Signature:
htri_t H5Iis_valid( hid_t obj_id )

Purpose:
Determines whether an identifier is valid.

Description:
H5Iis_valid determines whether the identifier obj_id is valid.

Valid identifiers are those that have been obtained by an application and can still be used to access the original target. Examples of invalid identifiers include:

H5Iis_valid can be used with any type of identifier: object identifier, property list identifier, attribute identifier, error message identifier, etc. When necessary, a call to H5Iget_type can determine the type of the object that obj_id identifies.

Parameters:
hid_t obj_id     IN: Identifier to validate

Returns:
Returns TRUE if obj_id is valid and FALSE if invalid. Otherwise returns a negative value.

See Also:

Fortran90 Interface:
SUBROUTINE h5iis_valid_f(id, valid, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN)  :: id ! Identifier 
  LOGICAL, INTENT(OUT) :: valid     ! Status of id as
                                    ! valid (.true.) or invalid (.false.)
  INTEGER, INTENT(OUT) :: hdferr    ! Error code: 0 on success, and -1 on failure
END SUBROUTINE h5iis_valid_f
	

History:
Release     Change
1.8.3 C function introduced in this release.