

<!--
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  * Copyright by The HDF Group.                                               *
  * Copyright by the Board of Trustees of the University of Illinois.         *
  * All rights reserved.                                                      *
  *                                                                           *
  * This file is part of HDF5.  The full HDF5 copyright notice, including     *
  * terms governing use, modification, and redistribution, is contained in    *
  * the files COPYING and Copyright.html.  COPYING can be found at the root   *
  * of the source code distribution tree; Copyright.html can be found at the  *
  * root level of an installed copy of the electronic HDF5 document set and   *
  * is linked from the top-level documents page.  It can also be found at     *
  * http://hdfgroup.org/HDF5/doc/Copyright.html.  If you do not have          *
  * access to either file, you may request a copy from help@hdfgroup.org.     *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 -->


<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Rdereference1" -->
<hr>
<dl>

  <dt><div align=right><font color=999999 size=-1><i>
  Last modified: 4 March 2016</i></font></div></dt>

<dt><strong>Name:</strong> <a name="Reference-Dereference1">H5Rdereference1</a>
</dt>
<br />
<dt><strong>Signature:</strong>
    <dd><em>hid_t</em> <code>H5Rdereference1</code>(
        <em>hid_t</em> <code>obj_id</code>,
        <em>H5R_type_t</em> <code>ref_type</code>,
        <em>void *</em><code>ref</code>
    )

<p>
<dt><strong>Purpose:</strong>
    <dd>Opens the HDF5 object referenced.

<p>
<dt><strong>Notice:</Strong>
  <dd><i>This function has been renamed from <code>H5Rdereference</code>
      and is deprecated in favor of the macro
      <a href="RM_H5R.html#Reference-Dereference"><code>H5Rdereference</code></a>
      or the function 
      <a href="RM_H5R.html#Reference-Dereference2"><code>H5Rdereference2</code></a>.</i>

<p>
<dt><strong>Description:</strong>
    <dd>Given a reference, <code>ref</code>, to an object or a region 
        in an object, <code>H5Rdereference1</code> opens that object and 
        returns an identifier.
        <p>
        The parameter <code>obj_id</code> must be a valid identifier for 
        an object in the HDF5 file containing the referenced object,
        including the file identifier.
        <p>
        The parameter <code>ref_type</code> specifies the reference type
        of the reference <code>ref</code>. 
        <code>ref_type</code> may contain either of the following values:
        <ul>
        <li><code>H5R_OBJECT</code>  (<code>0</code>)
        <li><code>H5R_DATASET_REGION</code>  (<code>1</code>)
        </ul>

        <p>The object opened with this function should be closed when 
        it is no longer needed so that resource leaks will not develop. 
        Use the appropriate close function such as <code>H5Oclose</code> 
        or <code>H5Dclose</code> for datasets.</p>

<p>
<dt><strong>Parameters:</strong>
    <dd><table>
        <tr>
            <td valign="top"><em>hid_t</em> <code>obj_id</code></td>
            <td valign="top">IN: Valid identifier for the file containing 
            the referenced object or any object in that file.</td></tr>
        <tr>
            <td valign="top"><em>H5R_type_t</em>&nbsp;<code>ref_type&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
            <td valign="top">IN: The reference type of <code>ref</code>.</td></tr>
        <tr>
            <td valign="top"><em>void *</em><code>ref</code></td>
            <td valign="top">IN: Reference to open.</td></tr>
    </table></dd>

<p>
<dt><strong>Returns:</strong>
    <dd>Returns identifier of referenced object if successful;
        otherwise returns a negative value.

<p>
<dt><strong>Fortran90 Interface:</strong> h5rdereference_f

    <dd>
    <p><strong>To dereference an object:</strong> 
    <br>

        <?php include("H5R/h5rdereference_object_f_F90.htm"); ?>

<!-- NEW PAGE -->
    <p><strong>To dereference a region:</strong>	
    <br>

        <?php include("H5R/h5rdereference_region_f_F90.htm"); ?>

<p>
<dt><strong>Fortran2003 Interface:</strong> h5rdereference_f
    <dd>

        <?php include("H5R/h5rdereference_f_F03.htm"); ?>


<br />
<dt><strong>See Also:</a></strong></dt>
    <dd>
    &ldquo;<a href=
    "http://www.hdfgroup.org/HDF5/doc/Advanced/UsingIdentifiers/index.html">Using 
    Identifiers</a>&rdquo;</dd>


<br />
<dt><strong>History:</strong>
    <dd><table width="90%">
        <tr>
          <td valign="top" align="left" width="10%">
            <strong>Release</strong>&nbsp;&nbsp;&nbsp;&nbsp;</td>
          <td valign="top" align="left">
            <strong>Change</strong></td></tr>
        <tr>
          <td valign="top">1.10.0</td>
          <td valign="top">
            C function <code>H5Rdereference</code> renamed to
            <code>H5Rdereference1</code> 
            and deprecated in this release.</td></tr>
        <tr>
          <td valign="top">1.8.8</td>
          <td valign="top">
            Fortran updated to Fortran2003.</td></tr>
        <tr>
          <td valign="top">1.8.0</td>
          <td valign="top">
            C function introduced in this release.</td></tr>
    </table>
</dl>


