

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

  <dt><div align=right><font color=999999 size=-1><i>
      Last modified: 29 September 2011
      </i></font></div>

  <dt><strong>Name:</strong> <a name="Property-GetFillValue">H5Pget_fill_value</a>
  <dt><strong>Signature:</strong>
    <dd><em>herr_t</em> <code>H5Pget_fill_value</code>(
        <em>hid_t</em> <code>plist_id</code>,
        <em>hid_t</em> <code>type_id</code>,
        <em>void *</em><code>value</code>
    )

  <p>
  <dt><strong>Purpose:</strong>
    <dd>Retrieves a dataset fill value.

  <p>
  <dt><strong>Description:</strong>
    <dd><code>H5Pget_fill_value</code> returns the dataset
        fill value defined in the dataset creation property list
        <code>plist_id</code>.
        <p>
	The fill value is returned through the <code>value</code>
        pointer and will be converted to the datatype specified 
        by <code>type_id</code>.  
        This datatype may differ from the 
        fill value datatype in the property list, 
	but the HDF5 library must be able to convert between the 
	two datatypes.  
        <p>
        If the fill value is undefined, 
	i.e., set to <code>NULL</code> in the property list,
	<code>H5Pget_fill_value</code> will return an error.  
	<code>H5Pfill_value_defined</code> should be used to 
	check for this condition before 
	<code>H5Pget_fill_value</code> is called.
        <p>
        Memory must be allocated by the calling application.  

  <p>
  <dt><strong>Note:</strong>
    <dd><code>H5Pget_fill_value</code> is designed to coordinate  
	with the dataset storage allocation time and 
	fill value write time properties, which can be retrieved 
	with the functions <code>H5Pget_alloc_time</code> 
	and <code>H5Pget_fill_time</code>, respectively.

  <p>
  <dt><strong>Parameters:</strong>
    <dd><table>
        <tr>
            <td valign="top"><em>hid_t</em>&nbsp;<code>plist_id&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
            <td valign="top">IN: Dataset creation property list 
                identifier.</td></tr>
        <tr>
            <td valign="top"><em>hid_t</em> <code>type_id</code>,</td>
            <td valign="top">IN: Datatype identifier for the value passed 
                via <code>value</code>.</td></tr>
        <tr><td valign="top"><em>void *</em><code>value</code></td>
            <td valign="top">OUT: Pointer to buffer to contain the returned 
                fill value.</td></tr>
    </table></dd>

  <p>
  <dt><strong>Returns:</strong>
    <dd>Returns a non-negative value if successful;
        otherwise returns a negative value.

  <p>
  <dt><strong>Fortran90 Interface:</strong> h5pget_fill_value_f
    <dd>

        <?php include("H5P/h5pget_fill_value_f_F90.htm"); ?>

<!-- NEW PAGE -->
  <p>
  <dt><strong>Fortran2003 Interface:</strong> h5pget_fill_value_f
    <dd>

        <?php include("H5P/h5pget_fill_value_f_F03.htm"); ?>

  <p></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.8</td>
          <td valign="top">
              Fortran updated to Fortran2003.</td></tr>
    </table>

</dl>

 
