

<!--
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  * 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 "H5Oget_info_by_name" -->
<hr>
<dl>

  <dt><div align=right><font color=999999 size=-1><i>
    Last modified: 15 April 2013
    </i></font></div>

  <dt><strong>Name:</strong> <a name="Object-GetInfoByName">H5Oget_info_by_name</a>
  <dt><strong>Signature:</strong>
    <dd><em>herr_t</em> <code>H5Oget_info_by_name</code>(
        <em>hid_t</em> <code>loc_id</code>,
        <em>const char *</em><code>object_name</code>,
        <em>H5O_info_t</em> *<code>object_info</code>,
        <em>hid_t</em> <code>lapl_id</code>
    )
  <p>
  <dt><strong>Purpose:</strong>
    <dd>Retrieves the metadata for an object, identifying the object by 
    location and relative name.
  <p>
  <dt><strong>Description:</strong>
    <dd><code>H5Oget_info_by_name</code> specifies an object&rsquo;s
    location and name, <code>loc_id</code> and <code>object_name</code>, 
    respectively, and retrieves the metadata describing that object
    in <code>object_info</code>, an <em>H5O_info_t</em> struct.
    <p>
    The struct <em>H5O_info_t</em> is defined in <code>H5Opublic.h</code>
    and described in the
    <a href="#Object-GetInfo"><code>H5Oget_info</code></a> function entry.
    <p>
    The link access property list, <code>lapl_id</code>, 
    is not currently used; it should be passed in as <code>H5P_DEFAULT</code>.
  <p>
  <dt><strong>Parameters:</strong>
    <dd><table>
      <tr>
        <td valign="top"><em>hid_t</em> <code>loc_id</code></td>
        <td valign="top">IN: File or group identifier specifying location 
            of group in which object is located</td></tr>
      <tr>
        <td valign="top"><em>const char *</em><code>name</code></td>
        <td valign="top">IN: Name of group, relative to 
            <code>loc_id</code></td></tr>
      <tr>
        <td valign="top"><em>H5O_info_t&nbsp;*</em><code>object_info&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
        <td valign="top">OUT: Buffer in which to return object
            information</td></tr>
      <tr>
        <td valign="top"><em>hid_t</em> <code>lapl_id</code></td>
        <td valign="top">IN: Link access property list<br>
	    <cite>(Not currently used; 
	    pass as <code>H5P_DEFAULT</code>.)</cite></td></tr>
    </table>
  <p>
  <dt><strong>Returns:</strong>
    <dd>Returns a non-negative value if successful;
        otherwise returns a negative value.

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

        <?php include("H5O/h5oget_info_by_name_f_F03.htm"); ?>


    <br>&nbsp;
    <p>
    <strong>Related Fortran2003 Derived Type:</strong> h5o_info_t

        <?php include("H5O/h5o_info_t_F03.htm"); ?>

<!-- NEW PAGE -->
  <p>
  <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.8.0</td>
          <td valign="top">
            C function introduced in this release.</td></tr>
        <tr>
          <td valign="top">1.8.8</td>
          <td valign="top">
            Fortran 2003 subroutine and <code>h5o_info_t</code> derived type
            introduced in this release.</td></tr>
    </table>
</dl>


