From 2d2c6e8a18dcb19ea08e519ef4537161de277e83 Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Wed, 25 Jun 2003 14:49:04 -0500 Subject: [svn-r7105] Purpose: New function. "HDF5 Release 1.4 compatibility" note. Description: H5Rget_obj_type Added new function; replaces H5Rget_object_type. H5Rget_object_type Add "Provided for HDF5 Release 1.4 compatibility" note. Platforms tested: IE 5, Safari --- doc/html/RM_H5R.html | 96 +++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 91 insertions(+), 5 deletions(-) diff --git a/doc/html/RM_H5R.html b/doc/html/RM_H5R.html index 4eb2e22..8f72d8f 100644 --- a/doc/html/RM_H5R.html +++ b/doc/html/RM_H5R.html @@ -63,14 +63,19 @@ to specific objects and data regions in an HDF5 file. + +* Functions labelled with an asterisk (*) are provided only for +backwards compatibility with HDF5 Releases 1.4.x. +See further notes in the description of each function.
Alphabetical Listing @@ -85,7 +90,7 @@ to specific objects and data regions in an HDF5 file.        -
  • H5Rget_obj_type
    • +
  • H5Rget_obj_type
  • H5Rget_object_type @@ -290,6 +295,77 @@ facilitate moving easily between them.
    +
    Name: H5Rget_obj_type +
    Signature: +
    H5G_obj_t H5Rget_obj_type(hid_t id, + H5R_type_t ref_type, + void *ref + ) +
    Purpose: +
    Retrieves the type of object that an object reference points to. +
    Description: +
    Given type of object reference, ref_type, + and a reference to an object, ref, + H5Rget_obj_type + returns the type of the referenced object. +

    + Valid object reference types, to pass in as ref, include the following: + + + +
         + H5R_OBJECT + Reference is an object reference. +
      + H5R_DATASET_REGION   + Reference is a dataset region reference. +
    +

    + Valid object type return values include the following: + + + + + +
         + H5G_LINK + Object is a symbolic link. +
      + H5G_GROUP + Object is a group. +
      + H5G_DATASET   + Object is a dataset. +
      + H5G_TYPE + Object is a named datatype. +
    +

    Parameters: +
    +
    hid_t id, +
    IN: The dataset containing the reference object or + the location identifier of the object that the + dataset is located within. +
    H5R_type_t ref_type +
    IN: Type of reference to query. +
    void *ref +
    IN: Reference to query. +
    +
    Returns: +
    Returns an object type as defined in H5Gpublic.h if successful; + otherwise returns H5G_UNKNOWN. +
    Non-C API(s): +
    + +
    + + +
    +
    Name: H5Rget_object_type
    Signature:
    int H5Rget_object_type(hid_t id, @@ -298,7 +374,17 @@ facilitate moving easily between them.
    Purpose:
    Retrieves the type of object that an object reference points to.
    Description: -
    Given a reference to an object ref, +
    [NOTE: + This function is provided only to enable backward compatibility + with HDF5 Releases 1.4.x. + This function is enabled only if the HDF5 library is compiled + with the flag H5_WANT_H5_V1_4_COMPAT and is not + enabled in the binaries distributed by NCSA. + This function has been replaced in Release 1.6 by the function + H5Rget_object_type + and will eventually be deleted from the HDF5 distribution.] +

    +

    Given a reference to an object ref, H5Rget_object_type returns the type of the object pointed to.
    Parameters: @@ -363,7 +449,7 @@ And in this document, the Describes HDF5 Release 1.5, Unreleased Development Branch -Last modified: 6 June 2003 +Last modified: 25 June 2003 -- cgit v0.12