From 620c3d380d72addd9e141a1c60d931bd7cf3f8dc Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Fri, 17 Dec 1999 10:39:46 -0500 Subject: [svn-r1889] RM_H5F.html H5Fcreate, H5Fopen: Clarified description of file access flags in parameters section and removed reference to H5Fpublic.h. RM_H5D.html H5Dvlen_reclaim: Inserted missing punctuation. H5Dcreate: Added paragraph explaining that 'name' must be unique. --- doc/html/RM_H5D.html | 7 ++++++- doc/html/RM_H5F.html | 29 ++++++++++++++--------------- 2 files changed, 20 insertions(+), 16 deletions(-) diff --git a/doc/html/RM_H5D.html b/doc/html/RM_H5D.html index 63753c3..94ba4f5 100644 --- a/doc/html/RM_H5D.html +++ b/doc/html/RM_H5D.html @@ -150,6 +150,11 @@ facilitate moving easily between them. Dataset creation properties are specified by the argument create_plist_id.

+ Dataset names within a group are unique: + H5Dcreate will return an error if a dataset with + the name specified in name already exists at the + location specified in loc_id. +

create_plist_id is a H5P_DATASET_CREATE property list created with H5Pcreate() and initialized with the various functions described above. @@ -399,7 +404,7 @@ facilitate moving easily between them.

Name: H5Dvlen_reclaim
Signature: -
herr_t H5Dvlen_reclaim(hid_t type_id +
herr_t H5Dvlen_reclaim(hid_t type_id, hid_t space_id, hid_t plist_id, void *buf diff --git a/doc/html/RM_H5F.html b/doc/html/RM_H5F.html index b4f3044..27843b8 100644 --- a/doc/html/RM_H5F.html +++ b/doc/html/RM_H5F.html @@ -159,19 +159,19 @@ facilitate moving easily between them.
const char *name
Name of the file to access.
unsigned flags -
File access flags. Allowable values include: +
File access flags. Allowable values are:
    H5F_ACC_RDWR
    Allow read and write access to file.
    H5F_ACC_RDONLY
    Allow read-only access to file. -
    H5F_ACC_DEBUG -
    Print debug information. - (Used only by HDF5 library developers. - Do not use this flag in applications.)
- H5F_ACC_RDWR and H5F_ACC_RDONLY +
  • H5F_ACC_RDWR and H5F_ACC_RDONLY are mutually exclusive; use exactly one. +
  • An additional flag, H5F_ACC_DEBUG, prints + debug information. This flag is used only by HDF5 library + developers; it is neither tested nor supported + for use in applications.
    hid_t access_id
    Identifier for the file access properties list. If parallel file access is desired, this is a collective @@ -217,27 +217,26 @@ facilitate moving easily between them. are controlled through the file-creation and file-access property lists. The value of H5P_DEFAULT for a property list value indicates that the library should use - the default values for the appropriate property list. Also see - H5Fpublic.h for the list of supported flags. + the default values for the appropriate property list.
    Parameters:
    const char *name
    Name of the file to access.
    uintn flags -
    File access flags. Allowable values include: +
    File access flags. Allowable values are:
      H5F_ACC_TRUNC
      Truncate file, if it already exists, erasing all data previously stored in the file.
      H5F_ACC_EXCL
      Fail if file already exists. -
      H5F_ACC_DEBUG -
      Print debug information. - (Used only by HDF5 library developers. - Do not use this flag in applications.)
    - H5F_ACC_TRUNC and H5F_ACC_EXCL +
  • H5F_ACC_TRUNC and H5F_ACC_EXCL are mutually exclusive; use exactly one. +
  • An additional flag, H5F_ACC_DEBUG, prints + debug information. This flag is used only by HDF5 library + developers; it is neither tested nor supported + for use in applications.
    hid_t create_id
    File creation property list identifier, used when modifying default file meta-data. @@ -553,7 +552,7 @@ facilitate moving easily between them.
    Purpose:
    Reopens an HDF5 file.
    Description: - H5Freopen reopens an HDF5 file. The new +
    H5Freopen reopens an HDF5 file. The new file identifier which is returned points to the same file as the specified file idetifier, file_id. Both identifiers share caches and other information. -- cgit v0.12