<html>
<head><title>
HDF5/H5O API Specification
</title>
<link href="../ed_styles/RMelect.css" rel="stylesheet" type="text/css">
</head>

<body bgcolor="#FFFFFF">

<!-- #BeginLibraryItem "/ed_libs/styles_RM.lbi" -->
<!--
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  * 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://www.hdfgroup.org/HDF5/doc/Copyright.html.  If you do not have      *
  * access to either file, you may request a copy from help@hdfgroup.org.     *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 -->
<!-- #EndLibraryItem --><!-- HEADER RIGHT " " -->


<!-- #BeginLibraryItem "/ed_libs/NavBar_RM.lbi" -->
<hr>
<center>
<table border=0 width=98%>
<tr><td valign=top align=left>
<a href="../index.html">HDF5 documents and links</a>&nbsp;<br>
<a href="../H5.intro.html">Introduction to HDF5</a>&nbsp;<br>
<a href="../UG/HDF5_Users_Guide-Responsive HTML5/index.html">HDF5 User&rsquo;s Guide</a>&nbsp;<br>
<!--
<a href="Glossary.html">Glossary</a><br>
-->
</td>
<td valign=top align=right>
In the 
<a href="RM_H5Front.html">HDF5 Reference Manual</a>&nbsp;
<font size="-1"><br>
<a href="../HL/RM_H5DS.html">H5DS</a>&nbsp;&nbsp;
<a href="../HL/RM_H5IM.html">H5IM</a>&nbsp;&nbsp;
<a href="../HL/RM_H5LT.html">H5LT</a>&nbsp;&nbsp;
<a href="../HL/RM_H5PT.html">H5PT</a>&nbsp;&nbsp;
<a href="../HL/RM_H5TB.html">H5TB</a>&nbsp;
<a href="../HL/RM_HDF5Optimized.html">Optimized</a>&nbsp;
<br>
<a href="RM_H5.html">H5</a>&nbsp;&nbsp;
<a href="RM_H5A.html">H5A</a>&nbsp;&nbsp;
<a href="RM_H5D.html">H5D</a>&nbsp;&nbsp;
<a href="RM_H5E.html">H5E</a>&nbsp;&nbsp;
<a href="RM_H5F.html">H5F</a>&nbsp;&nbsp;
<a href="RM_H5G.html">H5G</a>&nbsp;&nbsp;
<a href="RM_H5I.html">H5I</a>&nbsp;&nbsp;
<a href="RM_H5L.html">H5L</a>&nbsp;
<br>
<a href="RM_H5O.html">H5O</a>&nbsp;&nbsp;
<a href="RM_H5P.html">H5P</a>&nbsp;&nbsp;
<a href="RM_H5PL.html">H5PL</a>&nbsp;&nbsp;
<a href="RM_H5R.html">H5R</a>&nbsp;&nbsp;
<a href="RM_H5S.html">H5S</a>&nbsp;&nbsp;
<a href="RM_H5T.html">H5T</a>&nbsp;&nbsp;
<a href="RM_H5Z.html">H5Z</a>&nbsp;
<br>
<a href="Tools.html">Tools</a>&nbsp;&nbsp;
<a href="PredefDTypes.html">Datatypes</a>&nbsp;&nbsp;
<a href="../fortran/index.html">Fortran</a>&nbsp;&nbsp;
<a href="APICompatMacros.html">Compatibility Macros</a>&nbsp;
<br>
<a href="CollectiveCalls.html">Collective Calls in Parallel</a>&nbsp;
</font>
<!--
<br>
<i><font size=-1>(Printable <a href="http://hdfgroup.org/HDF5/doc/PSandPDF/HDF5_RefManual.PDF">PDF</a> of this Reference Manual)</font></i>&nbsp;
-->

</td></tr>
</table>
</center>
<hr>
<!-- #EndLibraryItem --><center>
<h1>H5O: Object Interface</h1>
</center>

<h2>Object API Functions</h2>

The Object interface, H5O, functions manipulate objects in an HDF5 file.
This interface is designed to be used in conjunction with the 
Links interface (H5L).
<p>
<strong>The C Interfaces:</strong>

<table border=0>
<tr><td valign=top>
<ul>
    <li><a href="#Object-Open">H5Oopen</a>
    <li><a href="#Object-OpenByIdx">H5Oopen_by_idx</a>
    <li><a href="#Object-OpenByAddr">H5Oopen_by_addr</a>
    <li><a href="#Object-Link">H5Olink</a> 
    <li><a href="#Object-Close">H5Oclose</a>
    <li><a href="#Object-Copy">H5Ocopy</a>
</ul>
</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top> 
<ul>
    <li><a href="#Object-Visit">H5Ovisit</a>
    <li><a href="#Object-VisitByName">H5Ovisit_by_name</a>
    <li><a href="#Object-SetComment">H5Oset_comment</a>&nbsp;*
    <li><a href="#Object-SetCommentByName">H5Oset_comment_by_name</a>&nbsp;*
    <li><a href="#Object-GetComment">H5Oget_comment</a>
    <li><a href="#Object-GetCommentByName">H5Oget_comment_by_name</a>
</ul>
</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top>
<ul>
    <li><a href="#Object-ExistsByName">H5Oexists_by_name</a>
    <li><a href="#Object-GetInfo">H5Oget_info</a>
    <li><a href="#Object-GetInfoByName">H5Oget_info_by_name</a>
    <li><a href="#Object-GetInfoByIdx">H5Oget_info_by_idx</a>
    <li><a href="#Object-IncrRefCount">H5Oincr_refcount</a>
    <li><a href="#Object-DecrRefCount">H5Odecr_refcount</a>
</ul>
</td></tr>
<tr><td valign=top>
    <strong><code>&nbsp;&nbsp;&nbsp;&nbsp;</code>Struct:</strong>
<ul>
    <li><a href="#Object-McdtSearchCb_t">H5O_mcdt_search_cb_t</a>
</ul>
</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td>
<td align="right" valign="top" colspan="3">
    *&nbsp;<i>These functions have been deprecated.</i>
</td></tr>
</table>

<i>Alphabetical Listing</i>



<table border="0">
  <tr>
    <td valign="top">
      <ul>
      <li><a href="#Object-McdtSearchCb_t">H5O_mcdt_search_cb_t</a>
      <li><a href="#Object-Close">H5Oclose</a>
      <li><a href="#Object-Copy">H5Ocopy</a>
      <li><a href="#Object-DecrRefCount">H5Odecr_refcount</a>
      <li><a href="#Object-ExistsByName">H5Oexists_by_name</a>
      <li><a href="#Object-GetComment">H5Oget_comment</a>
      <li><a href="#Object-GetCommentByName">H5Oget_comment_by_name</a>
      </ul>     
    </td> 
    
    <td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td>
    
    <td valign="top">
      <ul>
      <li><a href="#Object-GetInfo">H5Oget_info</a>
      <li><a href="#Object-GetInfoByIdx">H5Oget_info_by_idx</a>
      <li><a href="#Object-GetInfoByName">H5Oget_info_by_name</a>
      <li><a href="#Object-IncrRefCount">H5Oincr_refcount</a>
      <li><a href="#Object-Link">H5Olink</a> 
      <li><a href="#Object-Open">H5Oopen</a>
      </ul>
    </td>
    
    <td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td>
    
    <td valign="top">
      <ul>
      <li><a href="#Object-OpenByAddr">H5Oopen_by_addr</a>
      <li><a href="#Object-OpenByIdx">H5Oopen_by_idx</a>
      <li><a href="#Object-SetComment">H5Oset_comment</a>&nbsp;*
      <li><a href="#Object-SetCommentByName">H5Oset_comment_by_name</a>&nbsp;*
      <li><a href="#Object-Visit">H5Ovisit</a>
      <li><a href="#Object-VisitByName">H5Ovisit_by_name</a>
      </ul>
    </td>
  </tr>
</table>

<br>
<strong>The Fortran Interface:</strong>
<br>
In general, each Fortran subroutine performs exactly the same task 
as the corresponding C function.   
<br>
<table border="0">
  <tr>
    <td valign="top">
      <ul>
          <li><a href="#Object-Link">h5olink_f</a>
          <li><a href="#Object-Open">h5oopen_f</a>
          <li><a href="#Object-OpenByAddr">h5oopen_by_addr_f</a>
          <li><a href="#Object-OpenByIdx">h5oopen_by_idx_f</a>
          <li><a href="#Object-Copy">h5ocopy_f</a>
          <li><a href="#Object-Close">h5oclose_f</a>
      </ul>     
    </td> 
    
    <td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
        &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
        &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td>
    
    <td valign="top">
      <ul>
          <li><a href="#Object-Visit">h5ovisit_f</a>
          <li><a href="#Object-VisitByName">h5ovisit_by_name_f</a>
          <li><a href="#Object-ExistsByName">h5oexists_by_name_f</a>
          <li><a href="#Object-DecrRefCount">h5odecr_refcount_f</a>
          <li><a href="#Object-IncrRefCount">h5oincr_refcount_f</a>
          <li><a href="#Object-SetComment">h5oset_comment_f</a>
      </ul>
    </td>
    
    <td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
        &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
        &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td>
    
    <td valign="top">
      <ul>
          <li><a href="#Object-SetCommentByName">h5oset_comment_by_name_f</a>
          <li><a href="#Object-GetComment">h5oget_comment_f</a>
          <li><a href="#Object-GetCommentByName">h5oget_comment_by_name_f</a>
          <li><a href="#Object-GetInfo">h5oget_info_f</a>
          <li><a href="#Object-GetInfoByName">h5oget_info_by_name_f</a>
          <li><a href="#Object-GetInfoByIdx">h5oget_info_by_idx_f</a>
      </ul>
    </td>
  </tr>
  <tr>
    <td valign="top" align="left" colspan="5">
      <strong><code>&nbsp;&nbsp;&nbsp;&nbsp;</code>Fortran2003 
          Derived Type:</strong>
      <ul>
          <li><a href="#h5o_info_t">h5o_info_t</a>
      </ul>
    </td>
  </tr>
</table>

<p>

<!-- NEW PAGE -->
<!-- HEADER RIGHT " " -->



<!--  ---  ---  ---  ---  ---  ---  ---  ---  ---  ---  ---  -->
<!--       Include special topic files                       -->
<!--  ---  ---  ---  ---  ---  ---  ---  ---  ---  ---  ---  -->

<?php include("../_topic/loc_id+name_obj.htm"); ?>

<!--  ---  ---  ---  ---  ---  ---  ---  ---  ---  ---  ---  -->
<!--       Include function files                            -->
<!--  ---  ---  ---  ---  ---  ---  ---  ---  ---  ---  ---  -->

<?php include("H5O/H5Oclose.htm"); ?>
<?php include("H5O/H5Ocopy.htm"); ?>
<?php include("H5O/H5Odecr_refcount.htm"); ?>
<?php include("H5O/H5Oexists_by_name.htm"); ?>
<?php include("H5O/H5Oget_comment.htm"); ?>
<?php include("H5O/H5Oget_comment_by_name.htm"); ?>
<?php include("H5O/H5Oget_info.htm"); ?>
<?php include("H5O/H5Oget_info_by_idx.htm"); ?>
<?php include("H5O/H5Oget_info_by_name.htm"); ?>
<?php include("H5O/H5Oincr_refcount.htm"); ?>
<?php include("H5O/H5Olink.htm"); ?>
<?php include("H5O/H5Oopen.htm"); ?>
<?php include("H5O/H5Oopen_by_addr.htm"); ?>
<?php include("H5O/H5Oopen_by_idx.htm"); ?>
<?php include("H5O/H5Oset_comment.htm"); ?>
<?php include("H5O/H5Oset_comment_by_name.htm"); ?>
<?php include("H5O/H5Ovisit.htm"); ?>
<?php include("H5O/H5Ovisit_by_name.htm"); ?>
<?php include("H5O/H5O_mcdt_search_cb_t.htm"); ?>


<!-- NEW PAGE -->
<!-- HEADER RIGHT " " -->
<!-- #BeginLibraryItem "/ed_libs/NavBar_RM.lbi" -->
<hr>
<center>
<table border=0 width=98%>
<tr><td valign=top align=left>
<a href="../index.html">HDF5 documents and links</a>&nbsp;<br>
<a href="../H5.intro.html">Introduction to HDF5</a>&nbsp;<br>
<a href="../UG/HDF5_Users_Guide-Responsive HTML5/index.html">HDF5 User&rsquo;s Guide</a>&nbsp;<br>
<!--
<a href="Glossary.html">Glossary</a><br>
-->
</td>
<td valign=top align=right>
In the 
<a href="RM_H5Front.html">HDF5 Reference Manual</a>&nbsp;
<font size="-1"><br>
<a href="../HL/RM_H5DS.html">H5DS</a>&nbsp;&nbsp;
<a href="../HL/RM_H5IM.html">H5IM</a>&nbsp;&nbsp;
<a href="../HL/RM_H5LT.html">H5LT</a>&nbsp;&nbsp;
<a href="../HL/RM_H5PT.html">H5PT</a>&nbsp;&nbsp;
<a href="../HL/RM_H5TB.html">H5TB</a>&nbsp;
<a href="../HL/RM_HDF5Optimized.html">Optimized</a>&nbsp;
<br>
<a href="RM_H5.html">H5</a>&nbsp;&nbsp;
<a href="RM_H5A.html">H5A</a>&nbsp;&nbsp;
<a href="RM_H5D.html">H5D</a>&nbsp;&nbsp;
<a href="RM_H5E.html">H5E</a>&nbsp;&nbsp;
<a href="RM_H5F.html">H5F</a>&nbsp;&nbsp;
<a href="RM_H5G.html">H5G</a>&nbsp;&nbsp;
<a href="RM_H5I.html">H5I</a>&nbsp;&nbsp;
<a href="RM_H5L.html">H5L</a>&nbsp;
<br>
<a href="RM_H5O.html">H5O</a>&nbsp;&nbsp;
<a href="RM_H5P.html">H5P</a>&nbsp;&nbsp;
<a href="RM_H5PL.html">H5PL</a>&nbsp;&nbsp;
<a href="RM_H5R.html">H5R</a>&nbsp;&nbsp;
<a href="RM_H5S.html">H5S</a>&nbsp;&nbsp;
<a href="RM_H5T.html">H5T</a>&nbsp;&nbsp;
<a href="RM_H5Z.html">H5Z</a>&nbsp;
<br>
<a href="Tools.html">Tools</a>&nbsp;&nbsp;
<a href="PredefDTypes.html">Datatypes</a>&nbsp;&nbsp;
<a href="../fortran/index.html">Fortran</a>&nbsp;&nbsp;
<a href="APICompatMacros.html">Compatibility Macros</a>&nbsp;
<br>
<a href="CollectiveCalls.html">Collective Calls in Parallel</a>&nbsp;
</font>
<!--
<br>
<i><font size=-1>(Printable <a href="http://hdfgroup.org/HDF5/doc/PSandPDF/HDF5_RefManual.PDF">PDF</a> of this Reference Manual)</font></i>&nbsp;
-->

</td></tr>
</table>
</center>
<hr>
<!-- #EndLibraryItem -->

<?php include("../ed_libs/Footer2.htm"); ?>

<SCRIPT LANGUAGE="JAVASCRIPT">
<!--
document.writeln("Last modified: 11 May 2015");
-->
</SCRIPT>


</body>
</html>

