Name: H5Pset_fapl_family
Signature:
  herr_t `H5Pset_fapl_family` ( hid_t `fapl_id`, hsize_t `memb_size`, hid_t `memb_fapl_id` )
Purpose:
  Sets the file access property list to use the family driver.
Description:
  `H5Pset_fapl_family` sets the file access property list identifier, `fapl_id`, to use the family driver.

  `memb_size` is the size in bytes of each file member. This size will be saved in file when the property list `fapl_id` is used to create a new file. If `fapl_id` is used to open an existing file, `memb_size` has to be equal to the original size saved in file. A failure with an error message indicating the correct member size will be returned if `memb_size` does not match the size saved. If any user does not know the original size, `H5F_FAMILY_DEFAULT` can be passed in. The library will retrieve the saved size.

  `memb_fapl_id` is the identifier of the file access property list to be used for each family member.

Parameters:

hid_t `fapl_id` | IN: File access property list identifier.
hsize_t `memb_size` | IN: Size in bytes of each file member.
hid_t `memb_fapl_id` | IN: Identifier of file access property list for each family member.

Returns:
  Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface: h5pset_fapl_family_f

      SUBROUTINE h5pset_fapl_family_f(prp_id, imemb_size, memb_plist, hdferr)
        IMPLICIT NONE
        INTEGER(HID_T), INTENT(IN)   :: prp_id    ! Property list identifier
        INTEGER(HSIZE_T), INTENT(IN) :: memb_size ! Logical size, in bytes,
                                                  ! of each family member
        INTEGER(HID_T), INTENT(IN) :: memb_plist  ! Identifier of the file
                                                  ! access property list to be
                                                  ! used for each family member
        INTEGER, INTENT(OUT) :: hdferr            ! Error code
                                                  ! 0 on success and -1 on failure
      END SUBROUTINE h5pset_fapl_family_f

History:

Release | C
1.4.0 | Function introduced in this release.
1.8.0 | Behavior of the `memb_size` parameter was changed.