From cccd86aa0edc1698478178ae90476281ac1caf5d Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Wed, 8 Oct 2003 16:26:05 -0500 Subject: [svn-r7576] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Corrected link to the F90 subroutine h5rget_object_type_f from the H5Rget_obj_type function description Platforms tested: IE 5, Safari --- doc/html/RM_H5R.html | 133 ++++++++++++++++++++++++++++----------------------- 1 file changed, 72 insertions(+), 61 deletions(-) diff --git a/doc/html/RM_H5R.html b/doc/html/RM_H5R.html index 5c2c4bd..f838e75 100644 --- a/doc/html/RM_H5R.html +++ b/doc/html/RM_H5R.html @@ -25,6 +25,7 @@ HDF5/H5R API Specification +
@@ -60,8 +61,7 @@ And in this document, the -
-
+

H5R: Reference Interface

@@ -91,9 +91,6 @@ 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 @@ -101,38 +98,44 @@ See further notes in the description of each function.
+        +        +
-

+
The FORTRAN90 Interfaces:
In general, each FORTRAN90 subroutine performs exactly the same task -as the corresponding C function. The links below go to the C function +as the corresponding C function. The links below (electronic versions only) go to the C function descriptions, which serve as general descriptions for both. A button, under Non-C API(s) at the end of the C function description, opens an external browser window displaying the FORTRAN90-specific information. You will probably want to adjust the size and location of this external window so that both browser windows are visible and to facilitate moving easily between them. - +
@@ -143,6 +146,7 @@ facilitate moving easily between them.
    @@ -154,6 +158,9 @@ facilitate moving easily between them.

    + + +

    Name: H5Rcreate @@ -221,7 +228,8 @@ facilitate moving easily between them. -->
    - + +
    Name: H5Rdereference @@ -264,51 +272,8 @@ facilitate moving easily between them. -->
    - -
    -
    -
    Name: H5Rget_region -
    Signature: -
    hid_t H5Rget_region(hid_t dataset, - H5R_type_t ref_type, - void *ref - ) -
    Purpose: -
    Retrieves a dataspace with the specified region selected. -
    Description: -
    Given a reference to an object ref, - H5Rget_region creates a copy of the dataspace - of the dataset pointed to and defines a selection in the copy - which is the region pointed to. -

    - The parameter ref_type specifies the reference type - of ref. - ref_type may contain the following value: -

      -
    • H5R_DATASET_REGION (1) -
    -
    Parameters: -
    -
    hid_t dataset, -
    IN: Dataset containing reference object. -
    H5R_type_t ref_type, -
    IN: The reference type of ref. -
    void *ref -
    IN: Reference to open. -
    -
    Returns: -
    Returns a valid identifier if successful; - otherwise returns a negative value. -
    Non-C API(s): -
    - -
    - - + +
    Name: H5Rget_obj_type @@ -372,7 +337,7 @@ facilitate moving easily between them.
    Returns an object type as defined in H5Gpublic.h if successful; otherwise returns H5G_UNKNOWN.
    Non-C API(s): -
    + +
    +
    +
    Name: H5Rget_region +
    Signature: +
    hid_t H5Rget_region(hid_t dataset, + H5R_type_t ref_type, + void *ref + ) +
    Purpose: +
    Retrieves a dataspace with the specified region selected. +
    Description: +
    Given a reference to an object ref, + H5Rget_region creates a copy of the dataspace + of the dataset pointed to and defines a selection in the copy + which is the region pointed to. +

    + The parameter ref_type specifies the reference type + of ref. + ref_type may contain the following value: +

      +
    • H5R_DATASET_REGION (1) +
    +
    Parameters: +
    +
    hid_t dataset, +
    IN: Dataset containing reference object. +
    H5R_type_t ref_type, +
    IN: The reference type of ref. +
    void *ref +
    IN: Reference to open. +
    +
    Returns: +
    Returns a valid identifier if successful; + otherwise returns a negative value. +
    Non-C API(s): +
    + +
    +
    @@ -414,14 +424,15 @@ And in this document, the
    -
    -
    +
    HDF Help Desk
    Describes HDF5 Release 1.6.0, July 2003 -
    - -Last modified: 25 June 2003 +
    -- cgit v0.12