summaryrefslogtreecommitdiffstats
path: root/doc/html/RM_H5P.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/RM_H5P.html')
-rw-r--r--doc/html/RM_H5P.html10
1 files changed, 8 insertions, 2 deletions
diff --git a/doc/html/RM_H5P.html b/doc/html/RM_H5P.html
index 2d0572a..bc6eae6 100644
--- a/doc/html/RM_H5P.html
+++ b/doc/html/RM_H5P.html
@@ -6799,8 +6799,14 @@ END SUBROUTINE h5pset_fapl_core_f
<dd><code>H5Pset_fapl_family</code> sets the file access property list
identifier, <code>fapl_id</code>, to use the family driver.
<p>
- <code>memb_size</code> is the size in bytes of each file member
- and is used only when creating a new file.
+ <code>memb_size</code> is the size in bytes of each file member. This size
+ will be saved in the file when the property list <code>fapl_id</code> is used
+ to create a new file. If <code>fapl_id</code> is used to open an existing
+ file, <code>memb_size</code> has to be equal to the original size saved in
+ the file. A failure with an errror message indicating the correct member
+ size will be returned if <code>memb_size</code> does not match the size saved.
+ If any user does not know the original size, <code>H5F_FAMILY_DEFAULT</code>
+ can be passed in. The library will retrieve the correct size saved in the file.
<p>
<code>memb_fapl_id</code> is the identifier of the
file access property list to be used for each family member.