<html>
<head><title>
HDF5/H5G 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;
<!--
<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;
-->
</font>
</td></tr>
</table>
</center>
<hr>
<!-- #EndLibraryItem --><center>
<h1>H5G: Group Interface</h1>
</center>

<h2>Group Object API Functions</h2>

The Group interface functions create and manipulate groups
of objects in an HDF5 file.
<br>
In the following lists, italic type indicates a configurable macro.
<p>
<strong>The C Interfaces:</strong>

<table border=0>
<tr><td valign=top>
<ul>
    <li><a href="#Group-Create"><i>H5Gcreate</i></a>
    <li><a href="#Group-Create1">H5Gcreate1</a>&nbsp;*
    <li><a href="#Group-Create2">H5Gcreate2</a>
    <li><a href="#Group-CreateAnon">H5Gcreate_anon</a>
    <li><a href="#Group-Open"><i>H5Gopen</i></a>
    <li><a href="#Group-Open1">H5Gopen1</a>&nbsp;*
    <li><a href="#Group-Open2">H5Gopen2</a>
    <li><a href="#Group-Close">H5Gclose</a>
</ul>
</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td>
<td valign=top> 
<ul>
    <li><a href="#Group-Move">H5Gmove</a>&nbsp;*
    <li><a href="#Group-Move2">H5Gmove2</a>&nbsp;*
    <li><a href="#Group-Link">H5Glink</a>&nbsp;*
    <li><a href="#Group-Link2">H5Glink2</a>&nbsp;*
    <li><a href="#Group-Unlink">H5Gunlink</a>&nbsp;*
    <li><a href="#Group-SetComment">H5Gset_comment</a>&nbsp;*
    <li><a href="#Group-GetComment">H5Gget_comment</a>&nbsp;*
    <li><a href="#Group-GetInfo">H5Gget_info</a>
    <li><a href="#Group-GetInfoByName">H5Gget_info_by_name</a>
</ul>
</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top>
<ul>
    <li><a href="#Group-GetObjinfo">H5Gget_objinfo</a>&nbsp;*
    <li><a href="#Group-GetNumObjs">H5Gget_num_objs</a>&nbsp;*
    <li><a href="#Group-GetCreatePlist">H5Gget_create_plist</a>
    <li><a href="#Group-GetLinkval">H5Gget_linkval</a>&nbsp;*
    <li><a href="#Group-Iterate">H5Giterate</a>&nbsp;*
    <li><a href="#Group-GetInfoByIdx">H5Gget_info_by_idx</a>
    <li><a href="#Group-GetObjNameByIdx">H5Gget_objname_by_idx</a>&nbsp;*
    <li><a href="#Group-GetObjTypeByIdx">H5Gget_objtype_by_idx</a>&nbsp;*
</ul>
</td></tr>
<tr><td align=right colspan=5>
    *&nbsp;<i>Use of these functions is deprecated in Release 1.8.0.</i>
</td></tr>
</table>

<i>Alphabetical Listing</i>

<table border="0">
  <tr>
    <td valign="top">
	<ul>
      <li><a href="#Group-Close">H5Gclose</a>
      <li><a href="#Group-Create"><i>H5Gcreate</i></a>
      <li><a href="#Group-Create1">H5Gcreate1</a>&nbsp;*
      <li><a href="#Group-Create2">H5Gcreate2</a>
      <li><a href="#Group-CreateAnon">H5Gcreate_anon</a>
      <li><a href="#Group-GetComment">H5Gget_comment</a>&nbsp;*
      <li><a href="#Group-GetCreatePlist">H5Gget_create_plist</a>
      <li><a href="#Group-GetLinkval">H5Gget_linkval</a>&nbsp;*
    </ul>     
    </td>
    
    <td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td>
    
    <td valign="top">
	<ul>
      <li><a href="#Group-GetInfo">H5Gget_info</a>
      <li><a href="#Group-GetInfoByIdx">H5Gget_info_by_idx</a>
      <li><a href="#Group-GetInfoByName">H5Gget_info_by_name</a>
      <li><a href="#Group-GetNumObjs">H5Gget_num_objs</a>&nbsp;*
      <li><a href="#Group-GetObjinfo">H5Gget_objinfo</a>&nbsp;*
      <li><a href="#Group-GetObjNameByIdx">H5Gget_objname_by_idx</a>&nbsp;*
      <li><a href="#Group-GetObjTypeByIdx">H5Gget_objtype_by_idx</a>&nbsp;*
      <li><a href="#Group-Iterate">H5Giterate</a>&nbsp;*
      <li><a href="#Group-Link">H5Glink</a>&nbsp;*
	</ul>
    </td>
    
    <td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td>
    
    <td valign="top">
	<ul>
      <li><a href="#Group-Link2">H5Glink2</a>&nbsp;*
      <li><a href="#Group-Move">H5Gmove</a>&nbsp;*
      <li><a href="#Group-Move2">H5Gmove2</a>&nbsp;*
      <li><a href="#Group-Open"><i>H5Gopen</i></a>
      <li><a href="#Group-Open1">H5Gopen1</a>&nbsp;*
      <li><a href="#Group-Open2">H5Gopen2</a>
      <li><a href="#Group-SetComment">H5Gset_comment</a>&nbsp;*
      <li><a href="#Group-Unlink">H5Gunlink</a>&nbsp;*
	</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="#Group-Close">h5gclose_f</a>
      <li><a href="#Group-Create"><i>h5gcreate_f</i></a>
      <li><a href="#Group-CreateAnon">h5gcreate_anon_f</a>
      <li><a href="#Group-GetComment">h5gget_comment_f</a>&nbsp;*
      <li><a href="#Group-GetCreatePlist">h5gget_create_plist_f</a>
      <li><a href="#Group-GetLinkval">h5gget_linkval_f</a>&nbsp;*
    </ul>     
    </td>
    
    <td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td>
    
    <td valign="top">
	<ul>
      <li><a href="#Group-GetInfo">h5gget_info_f</a>
      <li><a href="#Group-GetInfoByIdx">h5gget_info_by_idx_f</a>
      <li><a href="#Group-GetInfoByName">h5gget_info_by_name_f</a>
      <li><a href="#Group-Iterate">h5giterate_f</a>&nbsp;*
      <li><a href="#Group-Link">h5glink_f</a>&nbsp;*
	</ul>
    </td>
    
    <td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td>
    
    <td valign="top">
	<ul>
      <li><a href="#Group-Link2">h5glink2_f</a>&nbsp;*
      <li><a href="#Group-Move">h5gmove_f</a>&nbsp;*
      <li><a href="#Group-Move2">h5gmove2_f</a>&nbsp;*
      <li><a href="#Group-Open"><i>h5gopen_f</i></a>
      <li><a href="#Group-SetComment">h5gset_comment_f</a>&nbsp;*
      <li><a href="#Group-Unlink">h5gunlink_f</a>&nbsp;*
	</ul>
    </td>
  </tr>
<tr><td align=right colspan=5>
    *&nbsp;<i>Use of these functions is deprecated in Release 1.8.0.</i>
</td></tr>
</table>

<!-- NEW PAGE -->

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

<?php include("../_topic/groups_in_hdf5.htm"); ?>
<?php include("../_topic/locating_objects.htm"); ?>
<?php include("../_topic/group_implementations.htm"); ?>

<p>


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

<!-- NEW PAGE -->
<!-- HEADER RIGHT " " -->
<?php include("H5G/H5Gclose.htm"); ?>
<?php include("H5G/H5Gcreate.htm"); ?>
<?php include("H5G/H5Gcreate1.htm"); ?>
<?php include("H5G/H5Gcreate2.htm"); ?>
<?php include("H5G/H5Gcreate_anon.htm"); ?>
<?php include("H5G/H5Gget_comment.htm"); ?>
<?php include("H5G/H5Gget_create_plist.htm"); ?>
<?php include("H5G/H5Gget_info.htm"); ?>
<?php include("H5G/H5Gget_info_by_idx.htm"); ?>
<?php include("H5G/H5Gget_info_by_name.htm"); ?>
<?php include("H5G/H5Gget_linkval.htm"); ?>
<?php include("H5G/H5Gget_num_objs.htm"); ?>
<?php include("H5G/H5Gget_objinfo.htm"); ?>
<?php include("H5G/H5Gget_objname_by_idx.htm"); ?>
<?php include("H5G/H5Gget_objtype_by_idx.htm"); ?>
<?php include("H5G/H5Giterate.htm"); ?>
<?php include("H5G/H5Glink.htm"); ?>
<?php include("H5G/H5Glink2.htm"); ?>
<?php include("H5G/H5Gmove.htm"); ?>
<?php include("H5G/H5Gmove2.htm"); ?>
<?php include("H5G/H5Gopen.htm"); ?>
<?php include("H5G/H5Gopen1.htm"); ?>
<?php include("H5G/H5Gopen2.htm"); ?>
<?php include("H5G/H5Gset_comment.htm"); ?>
<?php include("H5G/H5Gunlink.htm"); ?>


<!-- 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;
<!--
<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;
-->
</font>
</td></tr>
</table>
</center>
<hr>
<!-- #EndLibraryItem -->

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

<SCRIPT LANGUAGE="JAVASCRIPT">
<!--
document.writeln("Last modified: 9 October 2014");
-->
</SCRIPT>


</body>
</html>

