diff options
Diffstat (limited to 'fortran/doc/DevelGuide/src/H5Pff_f90.html')
| -rw-r--r-- | fortran/doc/DevelGuide/src/H5Pff_f90.html | 4752 |
1 files changed, 4752 insertions, 0 deletions
diff --git a/fortran/doc/DevelGuide/src/H5Pff_f90.html b/fortran/doc/DevelGuide/src/H5Pff_f90.html new file mode 100644 index 0000000..0e9ff5c --- /dev/null +++ b/fortran/doc/DevelGuide/src/H5Pff_f90.html @@ -0,0 +1,4752 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> +<meta http-equiv="Content-Style-Type" content="text/css" /> +<meta http-equiv="Content-type" content="text/html; charset=ISO-8859-1" /> +<link rel="stylesheet" href="../robodoc.css" type="text/css" /> +<title>./src/H5Pff.f90</title> +<!-- Source: ./src/H5Pff.f90 --> +</head> +<body> +<div id="logo"> +<a name="robo_top_of_doc">HDF5 FORTRAN Developer's Guide</a> +</div> <!-- logo --> +<div id="navigation"> +<a class="menuitem" href="../toc_index.html#top">Table of Contents</a> +<a class="menuitem" href="../robo_sourcefiles.html#top">Sourcefiles</a> +<a class="menuitem" href="../masterindex.html#top">Index</a> +<a class="menuitem" href="../robo_functions.html#top">Functions</a> +<a class="menuitem" href="../robo_modules.html#top">Modules</a> +<a class="menuitem" href="../robo_procedures.html#top">Procedures</a> +<a class="menuitem" href="../robo_subroutines.html#top">Subroutines</a> +</div> <!-- navigation --> +<div id="content"> +<hr /> +<a name="ROBODoc2fH5P2028F9029"></a> +<a name="robo62"></a><h2>H5P (F90)</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_modules.html#robo_top_of_doc">Modules</a> ]</p> +<p class="item_name">NAME</p> +<pre> H5P_PROVISIONAL +</pre> +<p class="item_name">PURPOSE</p> +<pre> This file contains Fortran interfaces for H5P functions. It includes + all the functions that are independent on whether the Fortran 2003 functions + are enabled or disabled. +</pre> +<p class="item_name">NOTES</p> +<pre> *** IMPORTANT *** + If you add a new H5P function you must add the function name to the + Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory. + This is needed for Windows based operating systems. +</pre> + +<hr /> +<a name="H5P2f20h5pget5fhyper5fvector5fsize5ff"></a> +<a name="robo81"></a><h2> h5pget_hyper_vector_size_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> h5pget_hyper_vector_size_f +</pre> +<p class="item_name">PURPOSE</p> +<pre> Get the number of "I/O" vectors (vector size) +</pre> +<p class="item_name">INPUTS</p> +<pre> plist_id - dataset transfer property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> size - vector size + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + October 7, 2002 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE h5pget_hyper_vector_size_f<span class="sign">(</span>plist_id<span class="sign">,</span> size<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> plist_id <span class="sign">!</span> Dataset transfer property list identifier + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> size <span class="sign">!</span> Vector size + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2f20h5pset5ffamily5foffset5ff"></a> +<a name="robo82"></a><h2> h5pset_family_offset_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> h5pset_family_offset_f +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets offset for family file driver. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - file creation property list identifier + offset - file offset +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + 19 March 2003 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE h5pset_family_offset_f<span class="sign">(</span>prp_id<span class="sign">,</span> offset<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">(</span>HSIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> offset <span class="sign">!</span> Offset in bytes + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2f20h5pset5ffapl5ffamily5ff"></a> +<a name="robo83"></a><h2> h5pset_fapl_family_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> h5pset_fapl_family_f +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets the file access property list to use the family driver. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - file access property list identifier + memb_size - size in bytes of each file member + memb_plist - identifier of the file access property + list to be used for each family member +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE h5pset_fapl_family_f<span class="sign">(</span>prp_id<span class="sign">,</span> memb_size<span class="sign">,</span> memb_plist <span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">(</span>HSIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> memb_size <span class="sign">!</span> Logical size<span class="sign">,</span> in bytes<span class="sign">,</span> + <span class="sign">!</span> of each family member + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> memb_plist <span class="sign">!</span> Identifier of the file + <span class="sign">!</span> access property list <span class="keyword">for</span> + <span class="sign">!</span> each member of the family + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2f20h5pset5fmeta5fblock5fsize5ff"></a> +<a name="robo84"></a><h2> h5pset_meta_block_size_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> h5pset_meta_block_size_f +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets the minimum size of metadata block allocations +</pre> +<p class="item_name">INPUTS</p> +<pre> plist_id - file access property list identifier + size - metatdata block size +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + October 7, 2002 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE h5pset_meta_block_size_f<span class="sign">(</span>plist_id<span class="sign">,</span> size<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> plist_id <span class="sign">!</span> File access property list identifier + INTEGER<span class="sign">(</span>HSIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> size <span class="sign">!</span> Block size in bytes<span class="sign">;</span> + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pall5ffilters5favail5ff"></a> +<a name="robo200"></a><h2>h5pall_filters_avail_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pall_filters_avail_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Checks if all filters set in the dataset creation + property list are available +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - data creation property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> flag - .TRUE. if all filters are available + .FALSE. otherwise + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + April 10 2003 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pall_filters_avail_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> flag<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Dataset creation property + <span class="sign">!</span> list identifier + LOGICAL<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> flag <span class="sign">!</span> <span class="sign">.</span>TRUE<span class="sign">.</span> <span class="keyword">if</span> all filters are available + <span class="sign">!</span> <span class="sign">.</span>FALSE<span class="sign">.</span> otherwise + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pclose5fclass5ff"></a> +<a name="robo201"></a><h2>h5pclose_class_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pclose_class_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Closes an existing property list class. +</pre> +<p class="item_name">INPUTS</p> +<pre> class - Property list class identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + October 9, 2002 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pclose_class_f</strong><span class="sign">(</span>class<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> class <span class="sign">!</span> Property list class identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pclose5ff"></a> +<a name="robo202"></a><h2>h5pclose_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pclose_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Terminates access to a property list. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - identifier of the property list to + terminate access to. +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pclose_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pcopy5ff"></a> +<a name="robo203"></a><h2>h5pcopy_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pcopy_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Copies an existing property list to create a new + property list +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> new_prp_id - new property list identifier + hdferr: - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pcopy_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> new_prp_id<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> new_prp_id <span class="sign">!</span> Identifier of property list + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pcopy5fprop5ff"></a> +<a name="robo204"></a><h2>h5pcopy_prop_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pcopy_prop_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Copies a property from one list or class to another. +</pre> +<p class="item_name">INPUTS</p> +<pre> dst_id - Identifier of the destination property list + src_id - Identifier of the source property list + name - name of the property to copy +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr: - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + October 9, 2002 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pcopy_prop_f</strong><span class="sign">(</span>dst_id<span class="sign">,</span> src_id<span class="sign">,</span> name<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> dst_id <span class="sign">!</span> Destination property list + <span class="sign">!</span> identifier + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> src_id <span class="sign">!</span> Source property list identifier + CHARACTER<span class="sign">(</span>LEN<span class="sign">=</span><span class="sign">*</span><span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> name <span class="sign">!</span> Property name + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pcreate5ff"></a> +<a name="robo207"></a><h2>h5pcreate_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pcreate_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Creates a new property as an instance of a property + list class. +</pre> +<p class="item_name">INPUTS</p> +<pre> class - type of the property class to be created. + Possible values are: + H5P_FILE_CREATE_F + H5P_FILE_ACCESS_F + H5P_DATASET_CREATE_F + H5P_DATASET_XFER_F + H5P_FILE_MOUNT_F +</pre> +<p class="item_name">OUTPUTS</p> +<pre> prp_id - property list identifier + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pcreate_f</strong><span class="sign">(</span>class<span class="sign">,</span> prp_id<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> class <span class="sign">!</span> The type of the property list + <span class="sign">!</span> to be created<span class="sign">.</span> Possible values are<span class="sign">:</span> + <span class="sign">!</span> H5P_FILE_CREATE_F + <span class="sign">!</span> H5P_FILE_ACCESS_F + <span class="sign">!</span> H5P_DATASET_CREATE_F + <span class="sign">!</span> H5P_DATASET_XFER_F + <span class="sign">!</span> H5P_FILE_MOUNT_F + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pequal5ff"></a> +<a name="robo208"></a><h2>h5pequal_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pequal_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Checks if two property lists are eqaul +</pre> +<p class="item_name">INPUTS</p> +<pre> plist1_id - property list identifier + plist2_id - property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> flag - flag, possible values + .TRUE. or .FALSE. + hdferr: - error code + Success: 0 + Failure: -1, flag is set to .FALSE. +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + September 30, 2002 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pequal_f</strong><span class="sign">(</span>plist1_id<span class="sign">,</span> plist2_id<span class="sign">,</span> flag<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> plist1_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> plist2_id <span class="sign">!</span> Property list identifier + LOGICAL<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> flag <span class="sign">!</span> Flag + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pexist5ff"></a> +<a name="robo209"></a><h2>h5pexist_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pexist_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Queries whether a property name exists in a property list or class. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - property list identifier to query + name - name of property to check for +</pre> +<p class="item_name">OUTPUTS</p> +<pre> flag - logical flag + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + October 9, 2002 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pexist_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> name<span class="sign">,</span> flag<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + CHARACTER<span class="sign">(</span>LEN<span class="sign">=</span><span class="sign">*</span><span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> name <span class="sign">!</span> Name of property to modify + LOGICAL<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> flag <span class="sign">!</span> <span class="sign">.</span>TRUE<span class="sign">.</span> <span class="keyword">if</span> exists<span class="sign">,</span> <span class="sign">.</span>FALSE<span class="sign">.</span> otherwise + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pfill5fvalue5fdefined5ff"></a> +<a name="robo210"></a><h2>h5pfill_value_defined_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pfill_value_defined_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Check if fill value is defined. +</pre> +<p class="item_name">INPUTS</p> +<pre> plist_id - dataset creation property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> flag - fill value status flag + Possible values are: + H5D_FILL_VALUE_ERROR_F + H5D_FILL_VALUE_UNDEFINED_F + H5D_FILL_VALUE_DEFAULT_F + H5D_FILL_VALUE_USER_DEFINED_F + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + October 4, 2002 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pfill_value_defined_f</strong><span class="sign">(</span>plist_id<span class="sign">,</span> flag<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> plist_id <span class="sign">!</span> Dataset creation property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> flag <span class="sign">!</span> Fill value status flag + <span class="sign">!</span> H5D_FILL_VALUE_ERROR_F + <span class="sign">!</span> H5D_FILL_VALUE_UNDEFINED_F + <span class="sign">!</span> H5D_FILL_VALUE_DEFAULT_F + <span class="sign">!</span> H5D_FILL_VALUE_USER_DEFINED_F + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5falignment5ff"></a> +<a name="robo211"></a><h2>h5pget_alignment_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_alignment_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Retrieves the current settings for alignment + properties from a file access property list. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - file access property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> threshold - threshold value + alignment - alignment value + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_alignment_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> threshold<span class="sign">,</span> alignment<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">(</span>HSIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> threshold <span class="sign">!</span> Threshold value + INTEGER<span class="sign">(</span>HSIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> alignment <span class="sign">!</span> alignment value + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5falloc5ftime5ff"></a> +<a name="robo212"></a><h2>h5pget_alloc_time_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_alloc_time_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Get space allocation time for dataset during creation. +</pre> +<p class="item_name">INPUTS</p> +<pre> plist_id - dataset creation property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> flag - allocation time flag: + H5D_ALLOC_TIME_ERROR_F + H5D_ALLOC_TIME_DEFAULT_F + H5D_ALLOC_TIME_EARLY_F + H5D_ALLOC_TIME_LATE_F + H5D_ALLOC_TIME_INCR_F + hdferr: - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + October 4, 2002 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_alloc_time_f</strong><span class="sign">(</span>plist_id<span class="sign">,</span> flag<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> plist_id <span class="sign">!</span> Dataset creation property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> flag <span class="sign">!</span> Allocation time flag<span class="sign">:</span> + <span class="sign">!</span> H5D_ALLOC_TIME_ERROR_F + <span class="sign">!</span> H5D_ALLOC_TIME_DEFAULT_F + <span class="sign">!</span> H5D_ALLOC_TIME_EARLY_F + <span class="sign">!</span> H5D_ALLOC_TIME_LATE_F + <span class="sign">!</span> H5D_ALLOC_TIME_INCR_F + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fH5Pget5fattr5fcreation5forder5ff"></a> +<a name="robo213"></a><h2>H5Pget_attr_creation_order_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>H5Pget_attr_creation_order_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Retrieves tracking and indexing settings for attribute creation order +</pre> +<p class="item_name">INPUTS</p> +<pre> ocpl_id - Object (group or dataset) creation property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> crt_order_flags - Flags specifying whether to track and index attribute creation order + hdferr - Error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + February, 2008 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE h5pget_attr_creation_order_f<span class="sign">(</span>ocpl_id<span class="sign">,</span> crt_order_flags<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> ocpl_id <span class="sign">!</span> Object <span class="sign">(</span>group or dataset<span class="sign">)</span> creation property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> crt_order_flags <span class="sign">!</span> Flags specifying whether to track and index attribute creation order + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fH5Pget5fattr5fphase5fchange5ff"></a> +<a name="robo214"></a><h2>H5Pget_attr_phase_change_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>H5Pget_attr_phase_change_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Retrieves attribute storage phase change thresholds +</pre> +<p class="item_name">INPUTS</p> +<pre> ocpl_id - Object (dataset or group) creation property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> max_compact - Maximum number of attributes to be stored in compact storage + (Default: 8) + min_dense - Minimum number of attributes to be stored in dense storage + (Default: 6) + hdferr - Error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + January, 2008 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE h5pget_attr_phase_change_f<span class="sign">(</span>ocpl_id<span class="sign">,</span> max_compact<span class="sign">,</span> min_dense<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> ocpl_id <span class="sign">!</span> Object <span class="sign">(</span>dataset or group<span class="sign">)</span> creation property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> max_compact <span class="sign">!</span> Maximum number of attributes to be stored in compact storage + <span class="sign">!</span> <span class="sign">(</span>Default<span class="sign">:</span> 8<span class="sign">)</span> + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> min_dense <span class="sign">!</span> Minimum number of attributes to be stored in dense storage + <span class="sign">!</span> <span class="sign">(</span>Default<span class="sign">:</span> 6<span class="sign">)</span> + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fbtree5fratios5ff"></a> +<a name="robo215"></a><h2>h5pget_btree_ratios_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_btree_ratios_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Gets B-tree split ratios for a dataset transfer property list +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - the dataset transfer property list + identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> left - the B-tree split ratio for left-most nodes + middle - the B-tree split ratio for all other nodes + right - the B-tree split ratio for right-most nodes + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_btree_ratios_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> left<span class="sign">,</span> middle<span class="sign">,</span> right<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + REAL<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> left <span class="sign">!</span> The B<span class="sign">-</span>tree split ratio <span class="keyword">for</span> left<span class="sign">-</span>most nodes<span class="sign">.</span> + REAL<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> middle <span class="sign">!</span> The B<span class="sign">-</span>tree split ratio <span class="keyword">for</span> all other nodes + REAL<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> right <span class="sign">!</span> The B<span class="sign">-</span>tree split ratio <span class="keyword">for</span> right<span class="sign">-</span>most + <span class="sign">!</span> nodes and lone nodes<span class="sign">.</span> + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fbuffer5ff"></a> +<a name="robo216"></a><h2>h5pget_buffer_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_buffer_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Gets size for conversion buffer +</pre> +<p class="item_name">INPUTS</p> +<pre> plist_id - data transfer property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> size - buffer size + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + October 2, 2002 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_buffer_f</strong><span class="sign">(</span>plist_id<span class="sign">,</span> size<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> plist_id <span class="sign">!</span> Data transfer property list identifier + INTEGER<span class="sign">(</span>HSIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> size <span class="sign">!</span> Buffer size in bytes<span class="sign">;</span> + <span class="sign">!</span> buffer is allocated and freed by + <span class="sign">!</span> the library<span class="sign">.</span> + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fcache5ff"></a> +<a name="robo217"></a><h2>h5pget_cache_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_cache_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Queries the meta data cache and raw data chunk cache + parameters. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - file access property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> mdc_nelmts - number of elements (objects) in the meta + data cache + rdcc_nelmts - number of elements (objects) in the raw + data chunk cache + rdcc_nbytes - total size of the raw data chunk cache, in bytes + rdcc_w0 - preemption policy (0 or 1) + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + + Bug fix: type of the rdcc_nelmts parameter should be INTEGER + instead of INTEGER(SIZE_T) October 10, 2003 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_cache_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> mdc_nelmts<span class="sign">,</span> rdcc_nelmts<span class="sign">,</span> rdcc_nbytes<span class="sign">,</span> rdcc_w0<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> mdc_nelmts <span class="sign">!</span> Number of elements <span class="sign">(</span>objects<span class="sign">)</span> + <span class="sign">!</span> in the meta data cache + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> rdcc_nelmts <span class="sign">!</span> Number of elements <span class="sign">(</span>objects<span class="sign">)</span> + <span class="sign">!</span> in the meta data cache + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> rdcc_nbytes <span class="sign">!</span> Total size of the raw data + <span class="sign">!</span> chunk cache<span class="sign">,</span> in bytes + REAL<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> rdcc_w0 <span class="sign">!</span> Preemption policy + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fH5Pget5fchar5fencoding5ff"></a> +<a name="robo220"></a><h2>H5Pget_char_encoding_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>H5Pget_char_encoding_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Retrieves the character encoding used to create a string +</pre> +<p class="item_name">INPUTS</p> +<pre> plist_id - Property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> encoding - Valid values for encoding are: + H5T_CSET_ASCII_F -> US ASCII + H5T_CSET_UTF8_F -> UTF-8 Unicode encoding + hdferr - Error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + March 3, 2008 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE h5pget_char_encoding_f<span class="sign">(</span>plist_id<span class="sign">,</span> encoding<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> plist_id <span class="sign">!</span> Property list identifier + + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> encoding <span class="sign">!</span> Valid values <span class="keyword">for</span> encoding are<span class="sign">:</span> + <span class="sign">!</span> H5T_CSET_ASCII_F <span class="sign">-</span><span class="sign">></span> US ASCII + <span class="sign">!</span> H5T_CSET_UTF8_F <span class="sign">-</span><span class="sign">></span> UTF<span class="sign">-</span>8 Unicode encoding + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fH5Pget5fchunk5fcache5ff"></a> +<a name="robo221"></a><h2>H5Pget_chunk_cache_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>H5Pget_chunk_cache_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Retrieves the maximum possible number of elements in the meta + data cache and the maximum possible number of elements and + bytes and the RDCC_W0 value in the raw data chunk cache. Any + (or all) arguments may be null pointers in which case the + corresponding datum is not returned. If these properties have + not been set on this property list, the default values for a + file access property list are returned. +</pre> +<p class="item_name">INPUTS</p> +<pre> dapl_id - Dataset access property list identifier. +</pre> +<p class="item_name">OUTPUTS</p> +<pre> rdcc_nslots - Number of chunk slots in the raw data chunk cache hash table. + rdcc_nbytes - Total size of the raw data chunk cache, in bytes. + rdcc_w0 - Preemption policy. + hdferr - Error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + April 13, 2009 +</pre> +<p class="item_name">HISTORY</p> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE h5pget_chunk_cache_f<span class="sign">(</span>dapl_id<span class="sign">,</span> rdcc_nslots<span class="sign">,</span> rdcc_nbytes<span class="sign">,</span> rdcc_w0<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> dapl_id <span class="sign">!</span> Dataset access property list identifier<span class="sign">.</span> + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> rdcc_nslots <span class="sign">!</span> Number of chunk slots in the raw data chunk cache hash table<span class="sign">.</span> + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> rdcc_nbytes <span class="sign">!</span> Total size of the raw data chunk cache<span class="sign">,</span> in bytes<span class="sign">.</span> + REAL<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> rdcc_w0 <span class="sign">!</span> Preemption policy<span class="sign">.</span> + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code<span class="sign">:</span> + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fchunk5ff"></a> +<a name="robo222"></a><h2>h5pget_chunk_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_chunk_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Retrieves the size of chunks for the raw data of a + chunked layout dataset +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - property list identifier + ndims - size of dims array +</pre> +<p class="item_name">OUTPUTS</p> +<pre> dims - array with dimension sizes for each chunk + hdferr - error code + Success: number of chunk dimensions + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_chunk_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> ndims<span class="sign">,</span> dims<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> ndims <span class="sign">!</span> Number of chunk dimensions to + <span class="sign">!</span> to <span class="keyword">return</span> + INTEGER<span class="sign">(</span>HSIZE_T<span class="sign">)</span><span class="sign">,</span> DIMENSION<span class="sign">(</span>ndims<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> dims + <span class="sign">!</span> Array containing sizes of + <span class="sign">!</span> chunk dimensions + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code<span class="sign">:</span> + <span class="sign">!</span> number of chunk dimensions on success<span class="sign">,</span> + <span class="sign">!</span> <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fclass5ff"></a> +<a name="robo223"></a><h2>h5pget_class_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_class_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Returns the property list class for a property list. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> classtype - property list class + Possible values are: + H5P_ROOT_F + H5P_FILE_CREATE_F + H5P_FILE_ACCESS_F + H5PE_DATASET_CREATE_F + H5P_DATASET_XFER_F + H5P_FILE_MOUNT_F + hdferr: - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_class_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> classtype<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> classtype <span class="sign">!</span> The type of the property list + <span class="sign">!</span> to be created<span class="sign">.</span> Possible values are<span class="sign">:</span> + <span class="sign">!</span> H5P_ROOT_F + <span class="sign">!</span> H5P_FILE_CREATE_F + <span class="sign">!</span> H5P_FILE_ACCESS_F + <span class="sign">!</span> H5PE_DATASET_CREATE_F + <span class="sign">!</span> H5P_DATASET_XFER_F + <span class="sign">!</span> H5P_FILE_MOUNT_F + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fclass5fname5ff"></a> +<a name="robo224"></a><h2>h5pget_class_name_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_class_name_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Queries the name of a class. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - property list identifier to query +</pre> +<p class="item_name">OUTPUTS</p> +<pre> name - name of a class + size - Actual length of the class name + NOTE: If provided buffer "name" is smaller, + than name will be truncated to fit into + provided user buffer + hdferr: - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + October 9, 2002 +</pre> +<p class="item_name">HISTORY</p> +<pre> Returned the size of name as an argument +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_class_name_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> name<span class="sign">,</span> size<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + CHARACTER<span class="sign">(</span>LEN<span class="sign">=</span><span class="sign">*</span><span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> name <span class="sign">!</span> Buffer to retireve class name + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> size <span class="sign">!</span> Actual length of the class name + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fclass5fparent5ff"></a> +<a name="robo225"></a><h2>h5pget_class_parent_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_class_parent_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Retrieves the parent class of a genric property class. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - property list identifier to query +</pre> +<p class="item_name">OUTPUTS</p> +<pre> parent_id - identifier of the parent class + hdferr: - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + October 9, 2002 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_class_parent_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> parent_id<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> parent_id <span class="sign">!</span> Parent class property list + <span class="sign">!</span> identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fcopy5fobject5ff"></a> +<a name="robo226"></a><h2>h5pget_copy_object_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_copy_object_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Retrieves the properties to be used when an object is copied. +</pre> +<p class="item_name">INPUTS</p> +<pre> ocp_plist_id - Object copy property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> copy_options - Copy option(s) to be get + hdferr - Error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + March 3, 2008 +</pre> +<p class="item_name">HISTORY</p> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_copy_object_f</strong><span class="sign">(</span>ocp_plist_id<span class="sign">,</span> copy_options<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> ocp_plist_id <span class="sign">!</span> Object copy property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> copy_options <span class="sign">!</span> Valid copy options returned are<span class="sign">:</span> + <span class="sign">!</span> H5O_COPY_SHALLOW_HIERARCHY_F + <span class="sign">!</span> H5O_COPY_EXPAND_SOFT_LINK_F + <span class="sign">!</span> H5O_COPY_EXPAND_EXT_LINK_F + <span class="sign">!</span> H5O_COPY_EXPAND_REFERENCE_F + <span class="sign">!</span> H5O_COPY_WITHOUT_ATTR_FLAG_F + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fH5Pget5fcreate5finter5fgroup5ff"></a> +<a name="robo227"></a><h2>H5Pget_create_inter_group_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>H5Pget_create_inter_group_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Determines whether property is set to enable creating missing intermediate groups. +</pre> +<p class="item_name">INPUTS</p> +<pre> lcpl_id - Link creation property list identifier + crt_intermed_group - Specifying whether to create intermediate groups upon + the creation of an object +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - Error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + April 4, 2008 +</pre> +<p class="item_name">HISTORY</p> +<pre> The long subroutine name (>31) on older f90 compilers causes problems + so the name was shortened +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE h5pget_create_inter_group_f<span class="sign">(</span>lcpl_id<span class="sign">,</span> crt_intermed_group<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> lcpl_id <span class="sign">!</span> Link creation property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> crt_intermed_group <span class="sign">!</span> Flag specifying whether to create intermediate groups + <span class="sign">!</span> upon creation of an object + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fdata5ftransform5ff"></a> +<a name="robo228"></a><h2>h5pget_data_transform_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_data_transform_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Retrieves a data transform expression. +</pre> +<p class="item_name">INPUTS</p> +<pre> plist_id - Identifier of the property list or class +</pre> +<p class="item_name">OUTPUTS</p> +<pre> expression - buffer to hold transform expression + hdferr - Error code + Success: Actual lenght of the expression + If provided buffer "expression" is + smaller, than expression will be + truncated to fit into + provided user buffer + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + March 19, 2008 +</pre> +<p class="item_name">HISTORY</p> +<pre> Should hdferr return just 0 or 1 and add another arguement for the size? +</pre> +<p class="item_name">SOURCE</p> +<pre class="source">SUBROUTINE <strong>h5pget_data_transform_f</strong><span class="sign">(</span>plist_id<span class="sign">,</span> expression<span class="sign">,</span> hdferr<span class="sign">,</span> size<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> plist_id <span class="sign">!</span> Identifier of the property list or class + CHARACTER<span class="sign">(</span>LEN<span class="sign">=</span><span class="sign">*</span><span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> expression <span class="sign">!</span> Buffer to hold transform expression + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span><span class="sign">,</span> OPTIONAL <span class="sign">:</span><span class="sign">:</span> size <span class="sign">!</span> Registered size of the transform expression + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fdriver5ff"></a> +<a name="robo230"></a><h2>h5pget_driver_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_driver_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Returns low-lever driver identifier. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - file access or data transfer property + list identifier. +</pre> +<p class="item_name">OUTPUTS</p> +<pre> driver - low-level driver identifier + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_driver_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> driver<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> driver <span class="sign">!</span> Low<span class="sign">-</span>level file driver identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fedc5fcheck5ff"></a> +<a name="robo232"></a><h2>h5pget_edc_check_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_edc_check_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Queries error detecting +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - dataset creation property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + March 13, 2003 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_edc_check_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> flag<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Dataset transfer property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> flag <span class="sign">!</span> Checksum filter flag + <span class="sign">!</span> May have one of the following values<span class="sign">:</span> + <span class="sign">!</span> H5Z_ERROR_EDC_F + <span class="sign">!</span> H5Z_DISABLE_EDC_F + <span class="sign">!</span> H5Z_ENABLE_EDC_F + <span class="sign">!</span> H5Z_NO_EDC_F + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fH5Pget5fest5flink5finfo5ff"></a> +<a name="robo233"></a><h2>H5Pget_est_link_info_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>H5Pget_est_link_info_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Queries data required to estimate required local heap or object header size. +</pre> +<p class="item_name">INPUTS</p> +<pre> gcpl_id - Group creation property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> est_num_entries - Estimated number of links to be inserted into group + est_name_len - Estimated average length of link names + hdferr - Error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + March 21, 2008 +</pre> +<p class="item_name">HISTORY</p> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE h5pget_est_link_info_f<span class="sign">(</span>gcpl_id<span class="sign">,</span> est_num_entries<span class="sign">,</span> est_name_len<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> gcpl_id <span class="sign">!</span> Group creation property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> est_num_entries <span class="sign">!</span> Estimated number of links to be inserted into group + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> est_name_len <span class="sign">!</span> Estimated average length of link names + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fexternal5fcount5ff"></a> +<a name="robo234"></a><h2>h5pget_external_count_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_external_count_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Returns the number of external files for a dataset. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - dataset creation property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> count - number of external files for the + specified dataset + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_external_count_f</strong> <span class="sign">(</span>prp_id<span class="sign">,</span> count<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> count <span class="sign">!</span> Number of external files <span class="keyword">for</span> the + <span class="sign">!</span> Specified dataset + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fexternal5ff"></a> +<a name="robo235"></a><h2>h5pget_external_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_external_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Returns information about an external file. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - dataset creation property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> idx - external file index + name_size - maximum size of name array + name - name of the external file + name - name of external file + offset - offset in bytes from the beginning of the + file to the location in the file + where the data starts + bytes - size of the external file data + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_external_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> idx<span class="sign">,</span> name_size<span class="sign">,</span> name<span class="sign">,</span> offset<span class="sign">,</span>bytes<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> idx <span class="sign">!</span> External file index<span class="sign">.</span> + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> name_size <span class="sign">!</span> Maximum length of name array + CHARACTER<span class="sign">(</span>LEN<span class="sign">=</span><span class="sign">*</span><span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> name <span class="sign">!</span> Name of an external file + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> offset <span class="sign">!</span> Offset<span class="sign">,</span> in bytes<span class="sign">,</span> from the beginning + <span class="sign">!</span> of the file to the location in the file + <span class="sign">!</span> where the data starts<span class="sign">.</span> + INTEGER<span class="sign">(</span>HSIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> bytes <span class="sign">!</span> Number of bytes reserved in the + <span class="sign">!</span> file <span class="keyword">for</span> the data + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5ffapl5fcore5ff"></a> +<a name="robo236"></a><h2>h5pget_fapl_core_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_fapl_core_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Queries core file driver properties. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - file access property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> increment - size, in bytes, of memory increments + backing_store - boolean flag indicating whether to write + the file contents to disk when the file is closed. + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_fapl_core_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> increment<span class="sign">,</span> backing_store<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> increment <span class="sign">!</span> File block size in bytes<span class="sign">.</span> + LOGICAL<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> backing_store <span class="sign">!</span> Flag to indicate that + <span class="sign">!</span> entire file contents are flushed to a file + <span class="sign">!</span> with the same name as this core file<span class="sign">.</span> + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5ffapl5fdirect5ff"></a> +<a name="robo237"></a><h2>h5pget_fapl_direct_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_fapl_direct_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Gets up use of the direct I/O driver. +</pre> +<p class="item_name">INPUTS</p> +<pre> fapl_id - File access property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> alignment - Required memory alignment boundary + block_size - File system block size + cbuf_size - Copy buffer size + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + March 21, 2008 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_fapl_direct_f</strong><span class="sign">(</span>fapl_id<span class="sign">,</span> alignment<span class="sign">,</span> block_size<span class="sign">,</span> cbuf_size<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> fapl_id <span class="sign">!</span> File access property list identifier + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> alignment <span class="sign">!</span> Required memory alignment boundary<span class="sign">!</span> + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> block_size <span class="sign">!</span> File system block size + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> cbuf_size <span class="sign">!</span> Copy buffer size + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5ffapl5ffamily5ff"></a> +<a name="robo238"></a><h2>h5pget_fapl_family_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_fapl_family_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Returns file access property list information. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - file access property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> memb_size - size in bytes of each file member + memb_plist - identifier of the file access property + list to be used for each family member + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_fapl_family_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> memb_size<span class="sign">,</span> memb_plist <span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">(</span>HSIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> memb_size <span class="sign">!</span> Logical size<span class="sign">,</span> in bytes<span class="sign">,</span> + <span class="sign">!</span> of each family member + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> memb_plist <span class="sign">!</span> Identifier of the file + <span class="sign">!</span> access property list <span class="keyword">for</span> + <span class="sign">!</span> each member of the family + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5ffapl5fmulti5ff"></a> +<a name="robo241"></a><h2>h5pget_fapl_multi_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_fapl_multi_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets up use of the multi-file driver. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - file creation property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> mem_map - mapping array + memb_fapl - property list for each memory usage type + memb_name - names of member file + relax - flag + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">OPTIONAL PARAMETERS</p> +<pre> maxlen_out - maximum length for memb_name array element +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + 24 March 2003 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_fapl_multi_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> memb_map<span class="sign">,</span> memb_fapl<span class="sign">,</span> memb_name<span class="sign">,</span> memb_addr<span class="sign">,</span> relax<span class="sign">,</span> hdferr<span class="sign">,</span> maxlen_out<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> File creation property list identifier + INTEGER<span class="sign">,</span> DIMENSION<span class="sign">(</span>0<span class="sign">:</span>H5FD_MEM_NTYPES_F<span class="sign">-</span>1<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> memb_map + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> DIMENSION<span class="sign">(</span>0<span class="sign">:</span>H5FD_MEM_NTYPES_F<span class="sign">-</span>1<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> memb_fapl + CHARACTER<span class="sign">(</span>LEN<span class="sign">=</span><span class="sign">*</span><span class="sign">)</span><span class="sign">,</span> DIMENSION<span class="sign">(</span>0<span class="sign">:</span>H5FD_MEM_NTYPES_F<span class="sign">-</span>1<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> memb_name + <span class="sign">!</span>INTEGER<span class="sign">(</span>HADDR_T<span class="sign">)</span><span class="sign">,</span> DIMENSION<span class="sign">(</span>0<span class="sign">:</span>H5FD_MEM_NTYPES_F<span class="sign">-</span>1<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> memb_addr + REAL<span class="sign">,</span> DIMENSION<span class="sign">(</span>0<span class="sign">:</span>H5FD_MEM_NTYPES_F<span class="sign">-</span>1<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> memb_addr + INTEGER<span class="sign">,</span> OPTIONAL<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> maxlen_out + LOGICAL<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> relax + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5ffclose5fdegree5ff"></a> +<a name="robo242"></a><h2>h5pget_fclose_degree_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_fclose_degree_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Returns the degree for the file close behavior. +</pre> +<p class="item_name">INPUTS</p> +<pre> fapl_id - File access property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> degree - Possible values are: + H5F_CLOSE_DEFAULT_F + H5F_CLOSE_WEAK_F + H5F_CLOSE_SEMI_F + H5F_CLOSE_STRONG_F + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + September 26, 2002 +</pre> +<p class="item_name">HISTORY</p> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_fclose_degree_f</strong><span class="sign">(</span>fapl_id<span class="sign">,</span> degree<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> fapl_id <span class="sign">!</span> File Access Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> degree <span class="sign">!</span> Possible values are<span class="sign">:</span> + <span class="sign">!</span> H5F_CLOSE_DEFAULT_F + <span class="sign">!</span> H5F_CLOSE_WEAK_F + <span class="sign">!</span> H5F_CLOSE_SEMI_F + <span class="sign">!</span> H5F_CLOSE_STRONG_F + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5ffill5ftime5ff"></a> +<a name="robo243"></a><h2>h5pget_fill_time_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_fill_time_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Get fill value writing time for dataset +</pre> +<p class="item_name">INPUTS</p> +<pre> plist_id - dataset creation property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr: - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">OPTIONAL PARAMETERS</p> +<pre> flag - fill time flag: + H5D_FILL_TIME_ERROR_F + H5D_FILL_TIME_ALLOC_F + H5D_FILL_TIME_NEVER_F +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + October 4, 2002 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_fill_time_f</strong><span class="sign">(</span>plist_id<span class="sign">,</span> flag<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> plist_id <span class="sign">!</span> Dataset creation property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> flag <span class="sign">!</span> Fill time flag<span class="sign">:</span> + <span class="sign">!</span> H5D_FILL_TIME_ERROR_F + <span class="sign">!</span> H5D_FILL_TIME_ALLOC_F + <span class="sign">!</span> H5D_FILL_TIME_NEVER_F + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5ffilter5fby5fid5ff"></a> +<a name="robo244"></a><h2>h5pget_filter_by_id_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_filter_by_id_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Returns information about a filter in a pipeline +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - data creation or transfer property list + identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> filter_id - filter identifier + flags - bit vector specifying certain general + properties of the filter + cd_nelmts - number of elements in cd_values + cd_values - auxiliary data for the filter + namelen - number of characters in the name buffer + name - buffer to retrieve filter name + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + April 10 2003 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_filter_by_id_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> filter_id<span class="sign">,</span> flags<span class="sign">,</span> cd_nelmts<span class="sign">,</span> cd_values<span class="sign">,</span> namelen<span class="sign">,</span> name<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> filter_id <span class="sign">!</span> Filter identifier + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>INOUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> cd_nelmts <span class="sign">!</span> Number of elements in cd_values<span class="sign">.</span> + INTEGER<span class="sign">,</span> DIMENSION<span class="comment">(*), INTENT(OUT) :: cd_values ! Auxiliary data for the filter. + INTEGER, INTENT(OUT) :: flags ! Bit vector specifying certain general + ! properties of the filter. + INTEGER(SIZE_T), INTENT(IN) :: namelen ! Anticipated number of characters in name. + CHARACTER(LEN=*)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> name <span class="sign">!</span> Name of the filter + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5ffilter5ff"></a> +<a name="robo245"></a><h2>h5pget_filter_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_filter_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Returns information about a filter in a pipeline +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - data creation or transfer property list + identifier + filter_number - sequence number within the filter + pipeline of the filter for which + information is sought +</pre> +<p class="item_name">OUTPUTS</p> +<pre> filter_id - filter identification number + flags - bit vector specifying certain general + properties of the filter + cd_nelmts - number of elements in cd_values + cd_values - auxiliary data for the filter + namelen - number of characters in the name buffer + name - buffer to retrieve filter name + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_filter_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> filter_number<span class="sign">,</span> flags<span class="sign">,</span> cd_nelmts<span class="sign">,</span> cd_values<span class="sign">,</span> namelen<span class="sign">,</span> name<span class="sign">,</span> filter_id<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> filter_number <span class="sign">!</span> Sequence number within the filter + <span class="sign">!</span> pipeline of the filter <span class="keyword">for</span> which + <span class="sign">!</span> information is sought + INTEGER<span class="sign">,</span> DIMENSION<span class="comment">(*), INTENT(OUT) :: cd_values ! Auxiliary data for the filter. + INTEGER, INTENT(OUT) :: flags ! Bit vector specifying certain general + ! properties of the filter. + INTEGER(SIZE_T), INTENT(INOUT) :: cd_nelmts ! Number of elements in cd_values. + INTEGER(SIZE_T), INTENT(IN) :: namelen ! Anticipated number of characters in name. + CHARACTER(LEN=*)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> name <span class="sign">!</span> Name of the filter + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> filter_id <span class="sign">!</span> Filter identification number + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fgc5freferences5ff"></a> +<a name="robo246"></a><h2>h5pget_gc_references_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_gc_references_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Returns garbage collecting references setting. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - file access property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> gc_reference - flag for stting garbage collection on + and off (1 or 0) + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_gc_references_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> gc_reference<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> gc_reference <span class="sign">!</span> The flag <span class="keyword">for</span> garbage collecting + <span class="sign">!</span> references <span class="keyword">for</span> the file + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fistore5fk5ff"></a> +<a name="robo249"></a><h2>h5pget_istore_k_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_istore_k_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Queries the 1/2 rank of an indexed storage B-tree. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - file creation property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> ik - 1/2 rank of chunked storage B-tree + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_istore_k_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> ik<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> ik <span class="sign">!</span> 1<span class="sign">/</span>2 rank of chunked storage B<span class="sign">-</span>tree + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5flayout5ff"></a> +<a name="robo250"></a><h2>h5pget_layout_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_layout_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Returns the layout of the raw data for a dataset. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - data creation property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> layout - type of storage layout for raw data + possible values are: + H5D_COMPACT_F + H5D_CONTIGUOUS_F + H5D_CHUNKED_F + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_layout_f</strong> <span class="sign">(</span>prp_id<span class="sign">,</span> layout<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> layout <span class="sign">!</span> Type of storage layout <span class="keyword">for</span> raw data + <span class="sign">!</span> possible values are<span class="sign">:</span> + <span class="sign">!</span> H5D_COMPACT_F<span class="sign">(</span>0<span class="sign">)</span> + <span class="sign">!</span> H5D_CONTIGUOUS_F<span class="sign">(</span>1<span class="sign">)</span> + <span class="sign">!</span> H5D_CHUNKED_F<span class="sign">(</span>2<span class="sign">)</span> + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fH5Pget5flink5fcreation5forder5ff"></a> +<a name="robo251"></a><h2>H5Pget_link_creation_order_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>H5Pget_link_creation_order_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Queries whether link creation order is tracked and/or indexed in a group. +</pre> +<p class="item_name">INPUTS</p> +<pre> gcpl_id - Group creation property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> crt_order_flags - Creation order flag(s) + hdferr - Error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + March 3, 2008 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE h5pget_link_creation_order_f<span class="sign">(</span>gcpl_id<span class="sign">,</span> crt_order_flags<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> gcpl_id <span class="sign">!</span> Group creation property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> crt_order_flags <span class="sign">!</span> Creation order flag<span class="sign">(</span>s<span class="sign">)</span> + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fH5Pget5flink5fphase5fchange5ff"></a> +<a name="robo252"></a><h2>H5Pget_link_phase_change_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>H5Pget_link_phase_change_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Queries the settings for conversion between compact and dense groups. +</pre> +<p class="item_name">INPUTS</p> +<pre> gcpl_id - Group creation property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> max_compact - Maximum number of attributes to be stored in compact storage + min_dense - Minimum number of attributes to be stored in dense storage + hdferr - Error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + February 20, 2008 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE h5pget_link_phase_change_f<span class="sign">(</span>gcpl_id<span class="sign">,</span> max_compact<span class="sign">,</span> min_dense<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> gcpl_id <span class="sign">!</span> Group creation property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> max_compact <span class="sign">!</span> Maximum number of attributes to be stored in compact storage + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> min_dense <span class="sign">!</span> Minimum number of attributes to be stored in dense storage + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fH5Pget5flocal5fheap5fsize5fhint5ff"></a> +<a name="robo253"></a><h2>H5Pget_local_heap_size_hint_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>H5Pget_local_heap_size_hint_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Queries the local heap size hint for original-style groups. +</pre> +<p class="item_name">INPUTS</p> +<pre> gcpl_id - Group creation property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> size_hint - Hint for size of local heap + hdferr - Error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + March 21, 2008 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE h5pget_local_heap_size_hint_f<span class="sign">(</span>gcpl_id<span class="sign">,</span> size_hint<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> gcpl_id <span class="sign">!</span> Group creation property list identifier + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> size_hint <span class="sign">!</span> Hint <span class="keyword">for</span> size of local heap + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fmeta5fblock5fsize5ff"></a> +<a name="robo254"></a><h2>h5pget_meta_block_size_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_meta_block_size_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Gets the minimum size of metadata block allocations +</pre> +<p class="item_name">INPUTS</p> +<pre> plist_id - file access property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> size - metatdata block size + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + October 7, 2002 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_meta_block_size_f</strong><span class="sign">(</span>plist_id<span class="sign">,</span> size<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> plist_id <span class="sign">!</span> File access property list identifier + INTEGER<span class="sign">(</span>HSIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> size <span class="sign">!</span> Block size in bytes<span class="sign">;</span> + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fnfilters5ff"></a> +<a name="robo255"></a><h2>h5pget_nfilters_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_nfilters_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Returns the number of filters in the pipeline. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - data creation or transfer property list + identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> nfilters - number of filters in the pipeline + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_nfilters_f</strong> <span class="sign">(</span>prp_id<span class="sign">,</span> nfilters<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> nfilters <span class="sign">!</span> The number of filters in the pipeline + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fnlinks5ff"></a> +<a name="robo256"></a><h2>h5pget_nlinks_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_nlinks_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Gets maximum number of soft or user-defined link traversals. +</pre> +<p class="item_name">INPUTS</p> +<pre> lapl_id - File access property list identifier + nlinks - Maximum number of links to traverse +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + March 24, 2008 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_nlinks_f</strong><span class="sign">(</span>lapl_id<span class="sign">,</span> nlinks<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> lapl_id <span class="sign">!</span> File access property list identifier + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> nlinks <span class="sign">!</span> Maximum number of links to traverse + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fnpros5ff"></a> +<a name="robo257"></a><h2>h5pget_npros_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_npros_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Queries number of properties in property list or class +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - iproperty list identifier to query +</pre> +<p class="item_name">OUTPUTS</p> +<pre> nprops - number of properties in property object + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + October 9, 2002 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE h5pget_nprops_f<span class="sign">(</span>prp_id<span class="sign">,</span> nprops<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> nprops <span class="sign">!</span> Number of properties + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fH5Pget5fobj5ftrack5ftimes5ff"></a> +<a name="robo258"></a><h2>H5Pget_obj_track_times_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>H5Pget_obj_track_times_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Returns whether times are tracked for an object. +</pre> +<p class="item_name">INPUTS</p> +<pre> plist_id - property list id + flag - object timestamp setting + .TRUE.,.FALSE. +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + February 22, 2008 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE h5pget_obj_track_times_f<span class="sign">(</span>plist_id<span class="sign">,</span> flag<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> plist_id <span class="sign">!</span> Dataset creation property + <span class="sign">!</span> list identifier + LOGICAL<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> flag <span class="sign">!</span> Object timestamp setting + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fpreserve5ff"></a> +<a name="robo259"></a><h2>h5pget_preserve_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_preserve_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Checks status of the dataset transfer property list. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> flag - status flag + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + + Datatype of the flag parameter is changed from + INTEGER to LOGICAL + June 4, 2003 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_preserve_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> flag<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + LOGICAL<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> flag <span class="sign">!</span> TRUE<span class="sign">/</span>FALSE flag<span class="sign">.</span> Shows status of the dataset<span class="squote">'s + ! transfer property for partial writing/reading + ! compound datatype + INTEGER, INTENT(OUT) :: hdferr ! Error code + ! 0 on success and -1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fsec25ff"></a> +<a name="robo262"></a><h2>h5pget_sec2_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_sec2_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> NOT AVAILABLE +</pre> +<p class="item_name">INPUTS</p> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + + SOURCE! SUBROUTINE <strong>h5pget_sec2_f</strong> (prp_id, sec2, hdferr) + IMPLICIT NONE + INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier + INTEGER, INTENT(OUT) :: sec2 ! value indicates whether the file + INTEGER, INTENT(OUT) :: hdferr ! Error code + 0 on success and -1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fsieve5fbuf5fsize5ff"></a> +<a name="robo263"></a><h2>h5pget_sieve_buf_size_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_sieve_buf_size_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Gets the maximum size of the data sieve buffer +</pre> +<p class="item_name">INPUTS</p> +<pre> plist_id - file access property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> size - sieve buffer size + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + October 7, 2002 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_sieve_buf_size_f</strong><span class="sign">(</span>plist_id<span class="sign">,</span> size<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> plist_id <span class="sign">!</span> File access property list identifier + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> size <span class="sign">!</span> Buffer size in bytes + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fsize5ff"></a> +<a name="robo264"></a><h2>h5pget_size_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_size_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Queries the size of a property value in bytes. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - property list identifier to query + name - name of property to query +</pre> +<p class="item_name">OUTPUTS</p> +<pre> size - size of property in bytes + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + October 9, 2002 +</pre> +<p class="item_name">HISTORY</p> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_size_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> name<span class="sign">,</span> size<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + CHARACTER<span class="sign">(</span>LEN<span class="sign">=</span><span class="sign">*</span><span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> name <span class="sign">!</span> Name of property to query + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> size <span class="sign">!</span> Size in bytes + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fsizes5ff"></a> +<a name="robo265"></a><h2>h5pget_sizes_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_sizes_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Retrieves the size of the offsets and lengths used + in an <a href="./HDF5_f90.html#robo76">HDF5</a> file +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - file creation property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> sizeof_addr - size of an object offset in bytes + sizeof_size - size of an object length in bytes + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_sizes_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> sizeof_addr<span class="sign">,</span> sizeof_size<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> sizeof_addr <span class="sign">!</span> Size of an object + <span class="sign">!</span> offset in bytes + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> sizeof_size <span class="sign">!</span> Size of an object + <span class="sign">!</span> length in bytes + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fsmall5fdata5fblock5fsize5ff"></a> +<a name="robo266"></a><h2>h5pget_small_data_block_size_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_small_data_block_size_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Gets the minimum size of "small" raw data block +</pre> +<p class="item_name">INPUTS</p> +<pre> plist_id - file access property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> size - small raw data block size + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + October 7, 2002 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_small_data_block_size_f</strong><span class="sign">(</span>plist_id<span class="sign">,</span> size<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> plist_id <span class="sign">!</span> File access property list identifier + INTEGER<span class="sign">(</span>HSIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> size <span class="sign">!</span> Small raw data block size + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fsplit5ff"></a> +<a name="robo267"></a><h2>h5pget_split_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_split_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> NOT AVAILABLE +</pre> +<p class="item_name">INPUTS</p> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"><span class="sign">!</span> SUBROUTINE <strong>h5pget_split_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> meta_ext_size<span class="sign">,</span> meta_ext<span class="sign">,</span> meta_plist<span class="sign">,</span>raw_ext_size<span class="sign">,</span><span class="sign">&</span> +<span class="sign">!</span> raw_ext<span class="sign">,</span> raw_plist<span class="sign">,</span> hdferr<span class="sign">)</span> +<span class="sign">!</span> IMPLICIT NONE +<span class="sign">!</span> INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier +<span class="sign">!</span> INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> meta_ext_size <span class="sign">!</span> Number of characters of the meta + <span class="sign">!</span> file extension to be copied to the + <span class="sign">!</span> meta_ext buffer + +<span class="sign">!</span> CHARACTER<span class="sign">(</span>LEN<span class="sign">=</span><span class="sign">*</span><span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> meta_ext <span class="sign">!</span>Name of the extension <span class="keyword">for</span> + <span class="sign">!</span>the metafile filename +<span class="sign">!</span> INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> meta_plist <span class="sign">!</span> Identifier of the meta file + <span class="sign">!</span> access property list +<span class="sign">!</span> INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> raw_ext_size <span class="sign">!</span> Number of characters of the raw + <span class="sign">!</span> file extension to be copied to the + <span class="sign">!</span> raw_ext buffer +<span class="sign">!</span> CHARACTER<span class="sign">(</span>LEN<span class="sign">=</span><span class="sign">*</span><span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> raw_ext <span class="sign">!</span>Name extension <span class="keyword">for</span> the raw file filename +<span class="sign">!</span> INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> raw_plist <span class="sign">!</span>Identifier of the raw file + <span class="sign">!</span>access property list +<span class="sign">!</span> INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fstdio5ff"></a> +<a name="robo268"></a><h2>h5pget_stdio_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_stdio_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> NOT AVAILABLE +</pre> +<p class="item_name">INPUTS</p> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"><span class="sign">!</span> SUBROUTINE <strong>h5pget_stdio_f</strong> <span class="sign">(</span>prp_id<span class="sign">,</span> io<span class="sign">,</span> hdferr<span class="sign">)</span> +<span class="sign">!</span> +<span class="sign">!</span> IMPLICIT NONE +<span class="sign">!</span> INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier +<span class="sign">!</span> INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> io <span class="sign">!</span> value indicates that the file + <span class="sign">!</span>access property list is set to + <span class="sign">!</span>the stdio driver +<span class="sign">!</span> INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fsym5fk5ff"></a> +<a name="robo269"></a><h2>h5pget_sym_k_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_sym_k_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Retrieves the size of the symbol table B-tree 1/2 rank + and the symbol table leaf node 1/2 size. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - file creation property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> ik - symbol table tree 1/2 rank + lk - symbol table node 1/2 size + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_sym_k_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> ik<span class="sign">,</span> lk<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> ik <span class="sign">!</span> Symbol table tree rank + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> lk <span class="sign">!</span> Symbol table node size + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fuserblock5ff"></a> +<a name="robo270"></a><h2>h5pget_userblock_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_userblock_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Gets user block size. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - file creation property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> block_size - size of the user block in bytes + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_userblock_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> block_size<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">(</span>HSIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> block_size <span class="sign">!</span> Size of the + <span class="sign">!</span> user<span class="sign">-</span>block in bytes + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pget5fversion5ff"></a> +<a name="robo271"></a><h2>h5pget_version_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pget_version_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Retrieves the version information of various objects + for a file creation property list +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - file createion property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> boot - super block version number + freelist - global freelist version number + stab - symbol table version number + shhdr - shared object header version number + hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pget_version_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> boot<span class="sign">,</span> freelist<span class="sign">,</span> <span class="sign">&</span> + stab<span class="sign">,</span> shhdr<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> DIMENSION<span class="sign">(</span><span class="sign">:</span><span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> boot <span class="sign">!</span> Array to put boot + <span class="sign">!</span> block version number + INTEGER<span class="sign">,</span> DIMENSION<span class="sign">(</span><span class="sign">:</span><span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> freelist <span class="sign">!</span> Array to put global + <span class="sign">!</span> Freelist version number + + INTEGER<span class="sign">,</span> DIMENSION<span class="sign">(</span><span class="sign">:</span><span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> stab <span class="sign">!</span> Array to put symbol + <span class="sign">!</span> table version number + INTEGER<span class="sign">,</span> DIMENSION<span class="sign">(</span><span class="sign">:</span><span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> shhdr <span class="sign">!</span> Array to put shared + <span class="sign">!</span> object header version number + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pisa5fclass5ff"></a> +<a name="robo281"></a><h2>h5pisa_class_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pisa_class_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Determines whether a property list is a member of a class. +</pre> +<p class="item_name">INPUTS</p> +<pre> plist - property list identifier + pclass - identifier of the property class +</pre> +<p class="item_name">OUTPUTS</p> +<pre> flag - .TRUE. if a member, .FALSE. otherwise + hdferr: - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + October 9, 2002 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pisa_class_f</strong><span class="sign">(</span>plist<span class="sign">,</span> pclass<span class="sign">,</span> flag<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> plist <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> pclass <span class="sign">!</span> Class identifier + LOGICAL<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> flag <span class="sign">!</span> logical flag + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pmodify5ffilter5ff"></a> +<a name="robo282"></a><h2>h5pmodify_filter_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pmodify_filter_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Adds a filter to the filter pipeline. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - data creation or transfer property list + identifier + filter - filter to be modified + flags - bit vector specifying certain general + properties of the filter + cd_nelmts - number of elements in cd_values + cd_values - auxiliary data for the filter +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + April 10 2003 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pmodify_filter_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> filter<span class="sign">,</span> flags<span class="sign">,</span> cd_nelmts<span class="sign">,</span> cd_values<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> filter <span class="sign">!</span> Filter to be modified + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> flags <span class="sign">!</span> Bit vector specifying certain general + <span class="sign">!</span> properties of the filter + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> cd_nelmts <span class="sign">!</span> Number of elements in cd_values + INTEGER<span class="sign">,</span> DIMENSION<span class="comment">(*), INTENT(IN) :: cd_values ! Auxiliary data for the filter + INTEGER, INTENT(OUT) :: hdferr ! Error code + ! 0 on success and -1 on failure +</pre> + +<hr /> +<a name="H5P2fh5premove5ff"></a> +<a name="robo292"></a><h2>h5premove_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5premove_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Removes a property from a property list. +</pre> +<p class="item_name">INPUTS</p> +<pre> plid - Property list identofoer + name - name of the property to remove +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr: - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + October 9, 2002 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5premove_f</strong><span class="sign">(</span>plid<span class="sign">,</span> name<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> plid <span class="sign">!</span> Property list identifier + CHARACTER<span class="sign">(</span>LEN<span class="sign">=</span><span class="sign">*</span><span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> name <span class="sign">!</span> Name of property to remove + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5premove5ffilter5ff"></a> +<a name="robo293"></a><h2>h5premove_filter_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5premove_filter_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Delete one or more filters from the filter pipeline. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - data creation or transfer property list + identifier + filter - filter to be removed +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Quincey Koziol + January 27 2004 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5premove_filter_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> filter<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Dataset creation property list + <span class="sign">!</span> identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> filter <span class="sign">!</span> Filter to be removed + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5falignment5ff"></a> +<a name="robo296"></a><h2>h5pset_alignment_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_alignment_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets alignment properties of a file access property list. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - file access property list identifier + threshold - threshold value + alignment - alignment value +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_alignment_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> threshold<span class="sign">,</span> alignment<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">(</span>HSIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> threshold <span class="sign">!</span> Threshold value + INTEGER<span class="sign">(</span>HSIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> alignment <span class="sign">!</span> alignment value + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5falloc5ftime5ff"></a> +<a name="robo297"></a><h2>h5pset_alloc_time_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_alloc_time_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Set space allocation time for dataset during creation. +</pre> +<p class="item_name">INPUTS</p> +<pre> plist_id - dataset creation property list identifier + flag - allocation time flag: + H5D_ALLOC_TIME_ERROR_F + H5D_ALLOC_TIME_DEFAULT_F + H5D_ALLOC_TIME_EARLY_F + H5D_ALLOC_TIME_LATE_F + H5D_ALLOC_TIME_INCR_F +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + October 4, 2002 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_alloc_time_f</strong><span class="sign">(</span>plist_id<span class="sign">,</span> flag<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> plist_id <span class="sign">!</span> Dataset creation property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> flag <span class="sign">!</span> Allocation time flag<span class="sign">:</span> + <span class="sign">!</span> H5D_ALLOC_TIME_ERROR_F + <span class="sign">!</span> H5D_ALLOC_TIME_DEFAULT_F + <span class="sign">!</span> H5D_ALLOC_TIME_EARLY_F + <span class="sign">!</span> H5D_ALLOC_TIME_LATE_F + <span class="sign">!</span> H5D_ALLOC_TIME_INCR_F + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fH5Pset5fattr5fcreation5forder5ff"></a> +<a name="robo298"></a><h2>H5Pset_attr_creation_order_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>H5Pset_attr_creation_order_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets tracking and indexing of attribute creation order +</pre> +<p class="item_name">INPUTS</p> +<pre> ocpl_id - Object creation property list identifier + crt_order_flags - Flags specifying whether to track and index attribute creation order +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - Error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + January, 2008 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE h5pset_attr_creation_order_f<span class="sign">(</span>ocpl_id<span class="sign">,</span> crt_order_flags <span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> ocpl_id <span class="sign">!</span> Object <span class="sign">(</span>dataset or group<span class="sign">)</span> creation property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> crt_order_flags <span class="sign">!</span> Flags specifying whether to track and index attribute creation order + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fH5Pset5fattr5fphase5fchange5ff"></a> +<a name="robo299"></a><h2>H5Pset_attr_phase_change_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>H5Pset_attr_phase_change_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets attribute storage phase change thresholds. +</pre> +<p class="item_name">INPUTS</p> +<pre> ocpl_id - Object (dataset or group) creation property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> max_compact - Maximum number of attributes to be stored in compact storage + (Default: 8) + min_dense - Minimum number of attributes to be stored in dense storage + (Default: 6) + hdferr - Error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + January, 2008 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source">SUBROUTINE h5pset_attr_phase_change_f<span class="sign">(</span>ocpl_id<span class="sign">,</span> max_compact<span class="sign">,</span> min_dense<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> ocpl_id <span class="sign">!</span> Object <span class="sign">(</span>dataset or group<span class="sign">)</span> creation property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> max_compact <span class="sign">!</span> Maximum number of attributes to be stored in compact storage + <span class="sign">!</span><span class="sign">(</span>Default<span class="sign">:</span> 8<span class="sign">)</span> + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> min_dense <span class="sign">!</span> Minimum number of attributes to be stored in dense storage + <span class="sign">!</span> <span class="sign">(</span>Default<span class="sign">:</span> 6<span class="sign">)</span> + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5fbtree5fratios5ff"></a> +<a name="robo300"></a><h2>h5pset_btree_ratios_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_btree_ratios_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets B-tree split ratios for a dataset transfer + property list. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - the dataset transfer property list + identifier + left - the B-tree split ratio for left-most nodes + middle - the B-tree split ratio for all other nodes + right - the B-tree split ratio for right-most nodes +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_btree_ratios_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> left<span class="sign">,</span> middle<span class="sign">,</span> right<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + REAL<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> left <span class="sign">!</span> The B<span class="sign">-</span>tree split ratio <span class="keyword">for</span> left<span class="sign">-</span>most nodes<span class="sign">.</span> + REAL<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> middle <span class="sign">!</span> The B<span class="sign">-</span>tree split ratio <span class="keyword">for</span> all other nodes + REAL<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> right <span class="sign">!</span> The B<span class="sign">-</span>tree split ratio <span class="keyword">for</span> right<span class="sign">-</span>most + <span class="sign">!</span> nodes and lone nodes<span class="sign">.</span> + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5fbuffer5ff"></a> +<a name="robo301"></a><h2>h5pset_buffer_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_buffer_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets sixe for conversion buffer +</pre> +<p class="item_name">INPUTS</p> +<pre> plist_id - data transfer property list identifier + size - buffer size +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr: - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + October 2, 2002 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_buffer_f</strong><span class="sign">(</span>plist_id<span class="sign">,</span> size<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> plist_id <span class="sign">!</span> Data transfer property list identifier + INTEGER<span class="sign">(</span>HSIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> size <span class="sign">!</span> Buffer size in bytes<span class="sign">;</span> + <span class="sign">!</span> buffer is allocated and freed by + <span class="sign">!</span> the library<span class="sign">.</span> + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5fcache5ff"></a> +<a name="robo302"></a><h2>h5pset_cache_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_cache_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets the meta data cache and raw data chunk + cache parameters +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - file access property list identifier + mdc_nelmts - number of elements (objects) in the meta + data cache + rdcc_nelmts - number of elements (objects) in the raw + data chunk cache + rdcc_nbytes - total size of the raw data chunk cache, in bytes + rdcc_w0 - preemption policy (0 or 1) +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_cache_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> mdc_nelmts<span class="sign">,</span>rdcc_nelmts<span class="sign">,</span> rdcc_nbytes<span class="sign">,</span> rdcc_w0<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> mdc_nelmts <span class="sign">!</span> Number of elements <span class="sign">(</span>objects<span class="sign">)</span> + <span class="sign">!</span> in the meta data cache + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> rdcc_nelmts <span class="sign">!</span> Number of elements <span class="sign">(</span>objects<span class="sign">)</span> + <span class="sign">!</span> in the meta data cache + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> rdcc_nbytes <span class="sign">!</span> Total size of the raw data + <span class="sign">!</span> chunk cache<span class="sign">,</span> in bytes + REAL<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> rdcc_w0 <span class="sign">!</span> Preemption policy + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fH5Pset5fchar5fencoding5ff"></a> +<a name="robo305"></a><h2>H5Pset_char_encoding_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>H5Pset_char_encoding_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets the character encoding used to encode a string. +</pre> +<p class="item_name">INPUTS</p> +<pre> plist_id - Property list identifier + encoding - Valid values for encoding are: + H5T_CSET_ASCII_F -> US ASCII + H5T_CSET_UTF8_F -> UTF-8 Unicode encoding +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - Error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + March 3, 2008 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE h5pset_char_encoding_f<span class="sign">(</span>plist_id<span class="sign">,</span> encoding<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> plist_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> encoding <span class="sign">!</span> String encoding character set<span class="sign">:</span> + <span class="sign">!</span> H5T_CSET_ASCII_F <span class="sign">-</span><span class="sign">></span> US ASCII + <span class="sign">!</span> H5T_CSET_UTF8_F <span class="sign">-</span><span class="sign">></span> UTF<span class="sign">-</span>8 Unicode encoding + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fH5Pset5fchunk5fcache5ff"></a> +<a name="robo306"></a><h2>H5Pset_chunk_cache_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>H5Pset_chunk_cache_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Set the number of objects in the meta data cache and the + maximum number of chunks and bytes in the raw data chunk cache. + Once set, these values will override the values in the file access + property list. Each of these values can be individually unset + (or not set at all) by passing the macros: + H5D_CHUNK_CACHE_NSLOTS_DFLT_F, + H5D_CHUNK_CACHE_NBYTES_DFLT_F, and/or + H5D_CHUNK_CACHE_W0_DFLT_F + as appropriate. + + The RDCC_W0 value should be between 0 and 1 inclusive and + indicates how much chunks that have been fully read or fully + written are favored for preemption. A value of zero means + fully read or written chunks are treated no differently than + other chunks (the preemption is strictly LRU) while a value + of one means fully read chunks are always preempted before + other chunks. +</pre> +<p class="item_name">INPUTS</p> +<pre> dapl_id - Dataset access property list identifier. + rdcc_nslots - The number of chunk slots in the raw data chunk cache for this dataset. + rdcc_nbytes - The total size of the raw data chunk cache for this dataset. + rdcc_w0 - The chunk preemption policy for this dataset. +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - Error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + April 13, 2009 +</pre> +<p class="item_name">HISTORY</p> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE h5pset_chunk_cache_f<span class="sign">(</span>dapl_id<span class="sign">,</span> rdcc_nslots<span class="sign">,</span> rdcc_nbytes<span class="sign">,</span> rdcc_w0<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> dapl_id <span class="sign">!</span> Dataset access property list identifier<span class="sign">.</span> + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> rdcc_nslots <span class="sign">!</span> The number of chunk slots in the raw data + <span class="sign">!</span> chunk cache <span class="keyword">for</span> this dataset<span class="sign">.</span> + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> rdcc_nbytes <span class="sign">!</span> The total size of the raw data chunk cache + <span class="sign">!</span> <span class="keyword">for</span> this dataset<span class="sign">.</span> + REAL<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> rdcc_w0 <span class="sign">!</span> The chunk preemption policy <span class="keyword">for</span> this dataset<span class="sign">.</span> + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5fchunk5ff"></a> +<a name="robo307"></a><h2>h5pset_chunk_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_chunk_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets the size of the chunks used to store + a chunked layout dataset. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - datatset creation property list identifier + ndims - number of dimensions for each chunk + dims - array with dimension sizes for each chunk +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_chunk_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> ndims<span class="sign">,</span> dims<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> ndims <span class="sign">!</span> Number of chunk dimensions + INTEGER<span class="sign">(</span>HSIZE_T<span class="sign">)</span><span class="sign">,</span> DIMENSION<span class="sign">(</span>ndims<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> dims + <span class="sign">!</span> Array containing sizes of + <span class="sign">!</span> chunk dimensions + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5fcopy5fobject5ff"></a> +<a name="robo308"></a><h2>h5pset_copy_object_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_copy_object_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets properties to be used when an object is copied. +</pre> +<p class="item_name">INPUTS</p> +<pre> ocp_plist_id - Object copy property list identifier + copy_options - Copy option(s) to be set +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + March 3, 2008 +</pre> +<p class="item_name">HISTORY</p> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_copy_object_f</strong><span class="sign">(</span>ocp_plist_id<span class="sign">,</span> copy_options<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> ocp_plist_id <span class="sign">!</span> Object copy property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> copy_options <span class="sign">!</span> Copy option<span class="sign">(</span>s<span class="sign">)</span> to be set<span class="sign">,</span> valid options are<span class="sign">:</span> + <span class="sign">!</span> H5O_COPY_SHALLOW_HIERARCHY_F + <span class="sign">!</span> H5O_COPY_EXPAND_SOFT_LINK_F + <span class="sign">!</span> H5O_COPY_EXPAND_EXT_LINK_F + <span class="sign">!</span> H5O_COPY_EXPAND_REFERENCE_F + <span class="sign">!</span> H5O_COPY_WITHOUT_ATTR_FLAG_F + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fH5Pset5fcreate5finter5fgroup5ff"></a> +<a name="robo309"></a><h2>H5Pset_create_inter_group_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>H5Pset_create_inter_group_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Specifies in property list whether to create missing intermediate groups. +</pre> +<p class="item_name">INPUTS</p> +<pre> lcpl_id - Link creation property list identifier + crt_intermed_group - crt_intermed_group specifying whether + to create intermediate groups upon the creation + of an object +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - Error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + February 22, 2008 +</pre> +<p class="item_name">HISTORY</p> +<pre> The long subroutine name (>31) on older f90 compilers causes problems + so had to shorten the name +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE h5pset_create_inter_group_f<span class="sign">(</span>lcpl_id<span class="sign">,</span> crt_intermed_group<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> lcpl_id <span class="sign">!</span> Link creation property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> crt_intermed_group <span class="sign">!</span> specifying whether to create intermediate groups + <span class="sign">!</span> upon the creation of an object + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5fdata5ftransform5ff"></a> +<a name="robo310"></a><h2>h5pset_data_transform_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_data_transform_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets a data transform expression. +</pre> +<p class="item_name">INPUTS</p> +<pre> plist_id - Identifier of the property list or class + expression - Buffer to hold transform expression +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + March 19, 2008 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_data_transform_f</strong><span class="sign">(</span>plist_id<span class="sign">,</span> expression<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> plist_id <span class="sign">!</span> Identifier of the property list or class + CHARACTER<span class="sign">(</span>LEN<span class="sign">=</span><span class="sign">*</span><span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> expression <span class="sign">!</span> Buffer to hold transform expression + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5fdeflate5ff"></a> +<a name="robo311"></a><h2>h5pset_deflate_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_deflate_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets compression method and compression level. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - property list identifier + level - compression level +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_deflate_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> level<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> level <span class="sign">!</span> Compression level + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5fedc5fcheck5ff"></a> +<a name="robo315"></a><h2>h5pset_edc_check_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_edc_check_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Enables/disables error detecting +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - dataset creation property list identifier + flag - EDC flag; possible values: + H5Z_DISABLE_EDC_F + H5Z_ENABLE_EDC_F +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + March 13, 2003 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_edc_check_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> flag<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> flag <span class="sign">!</span> Checksum filter flag + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5fest5flink5finfo5ff"></a> +<a name="robo316"></a><h2>h5pset_est_link_info_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_est_link_info_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets estimated number of links and length of link names in a group. +</pre> +<p class="item_name">INPUTS</p> +<pre> gcpl_id - Group creation property list identifier + est_num_entries - Estimated number of links to be inserted into group + est_name_len - Estimated average length of link names +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - Error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + March 21, 2008 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_est_link_info_f</strong><span class="sign">(</span>gcpl_id<span class="sign">,</span> est_num_entries<span class="sign">,</span> est_name_len<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> gcpl_id <span class="sign">!</span> Group creation property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> est_num_entries <span class="sign">!</span> Estimated number of links to be inserted into group + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> est_name_len <span class="sign">!</span> Estimated average length of link names + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5fexternal5ff"></a> +<a name="robo317"></a><h2>h5pset_external_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_external_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Adds an external file to the list of external files. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - dataset creation property list identifier + name - name of external file + offset - offset in bytes from the beginning of the + file to the location in the file + where the data starts + bytes - size of the external file data. +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_external_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> name<span class="sign">,</span> offset<span class="sign">,</span>bytes<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + CHARACTER<span class="sign">(</span>LEN<span class="sign">=</span><span class="sign">*</span><span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> name <span class="sign">!</span> Name of an external file + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> offset <span class="sign">!</span> Offset<span class="sign">,</span> in bytes<span class="sign">,</span> from the beginning + <span class="sign">!</span> of the file to the location in the file + <span class="sign">!</span> where the data starts<span class="sign">.</span> + INTEGER<span class="sign">(</span>HSIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> bytes <span class="sign">!</span> Number of bytes reserved in the + <span class="sign">!</span> file <span class="keyword">for</span> the data + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5ffapl5fcore5ff"></a> +<a name="robo318"></a><h2>h5pset_fapl_core_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_fapl_core_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Modifies the file access property list to use the + H5FD_CORE driver. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - file access property list identifier + increment - size, in bytes, of memory increments + backing_store - boolean flag indicating whether to write + the file contents to disk when the file is closed. +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_fapl_core_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> increment<span class="sign">,</span> backing_store<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> increment <span class="sign">!</span> File block size in bytes<span class="sign">.</span> + LOGICAL<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> backing_store <span class="sign">!</span> Flag to indicate that + <span class="sign">!</span> entire file contents are flushed to a file + <span class="sign">!</span> with the same name as this core file<span class="sign">.</span> + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5ffapl5fdirect5ff"></a> +<a name="robo319"></a><h2>h5pset_fapl_direct_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_fapl_direct_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets up use of the direct I/O driver. +</pre> +<p class="item_name">INPUTS</p> +<pre> fapl_id - File access property list identifier + alignment - Required memory alignment boundary + block_size - File system block size + cbuf_size - Copy buffer size +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + March 21, 2008 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source">SUBROUTINE <strong>h5pset_fapl_direct_f</strong><span class="sign">(</span>fapl_id<span class="sign">,</span> alignment<span class="sign">,</span> block_size<span class="sign">,</span> cbuf_size<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> fapl_id <span class="sign">!</span> File access property list identifier + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> alignment <span class="sign">!</span> Required memory alignment boundary<span class="sign">!</span> + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> block_size <span class="sign">!</span> File system block size + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> cbuf_size <span class="sign">!</span> Copy buffer size + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5ffapl5fmulti5fl"></a> +<a name="robo322"></a><h2>h5pset_fapl_multi_l</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_fapl_multi_l</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets up use of the multi-file driver. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - file creation property list identifier + mem_map - mapping array + memb_fapl - property list for each memory usage type + memb_name - names of member file + relax - flag +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + 20 March 2003 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_fapl_multi_l</strong><span class="sign">(</span>prp_id<span class="sign">,</span> memb_map<span class="sign">,</span> memb_fapl<span class="sign">,</span> memb_name<span class="sign">,</span> memb_addr<span class="sign">,</span> relax<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> File creation property list identifier + INTEGER<span class="sign">,</span> DIMENSION<span class="sign">(</span>0<span class="sign">:</span>H5FD_MEM_NTYPES_F<span class="sign">-</span>1<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> memb_map <span class="sign">!</span> Mapping array + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> DIMENSION<span class="sign">(</span>0<span class="sign">:</span>H5FD_MEM_NTYPES_F<span class="sign">-</span>1<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> memb_fapl <span class="sign">!</span> Property list <span class="keyword">for</span> each memory usage type + CHARACTER<span class="sign">(</span>LEN<span class="sign">=</span><span class="sign">*</span><span class="sign">)</span><span class="sign">,</span> DIMENSION<span class="sign">(</span>0<span class="sign">:</span>H5FD_MEM_NTYPES_F<span class="sign">-</span>1<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> memb_name <span class="sign">!</span> Names of member file + REAL<span class="sign">,</span> DIMENSION<span class="sign">(</span>0<span class="sign">:</span>H5FD_MEM_NTYPES_F<span class="sign">-</span>1<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> memb_addr + LOGICAL<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> relax <span class="sign">!</span> Flag + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5ffapl5fmulti5fs"></a> +<a name="robo323"></a><h2>h5pset_fapl_multi_s</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_fapl_multi_s</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets up use of the multi-file driver. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - file creation property list identifier + relax - flag +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + 31 March 2003 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_fapl_multi_s</strong><span class="sign">(</span>prp_id<span class="sign">,</span> relax<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> File creation property list identifier + LOGICAL<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> relax + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5ffapl5fsec25ff"></a> +<a name="robo324"></a><h2>h5pset_fapl_sec2_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_fapl_sec2_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets the sec2 driver. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - file access property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_fapl_sec2_f</strong> <span class="sign">(</span>prp_id<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5ffapl5fsplit5ff"></a> +<a name="robo325"></a><h2>h5pset_fapl_split_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_fapl_split_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Emulates the old split file driver. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - file access property list identifier + meta_ext - name of the extension for the metafile + filename + meta_plist - identifier of the meta file access property + list + raw_ext - name extension for the raw file filename + raw_plist - identifier of the raw file access property list +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_fapl_split_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> meta_ext<span class="sign">,</span> meta_plist<span class="sign">,</span> raw_ext<span class="sign">,</span> raw_plist<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + CHARACTER<span class="sign">(</span>LEN<span class="sign">=</span><span class="sign">*</span><span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> meta_ext <span class="sign">!</span> Name of the extension <span class="keyword">for</span> + <span class="sign">!</span> the metafile filename + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> meta_plist <span class="sign">!</span> Identifier of the meta file + <span class="sign">!</span> access property list + CHARACTER<span class="sign">(</span>LEN<span class="sign">=</span><span class="sign">*</span><span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> raw_ext <span class="sign">!</span> Name extension <span class="keyword">for</span> the raw file filename + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> raw_plist <span class="sign">!</span> Identifier of the raw file + <span class="sign">!</span> access property list + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5ffapl5fstdio5ff"></a> +<a name="robo326"></a><h2>h5pset_fapl_stdio_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_fapl_stdio_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets the standard I/O driver. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - file access property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_fapl_stdio_f</strong> <span class="sign">(</span>prp_id<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5ffclose5fdegree5ff"></a> +<a name="robo327"></a><h2>h5pset_fclose_degree_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_fclose_degree_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets the degree for the file close behavior. +</pre> +<p class="item_name">INPUTS</p> +<pre> fapl_id - file access property list identifier + degree - Possible values are: + H5F_CLOSE_DEFAULT_F + H5F_CLOSE_WEAK_F + H5F_CLOSE_SEMI_F + H5F_CLOSE_STRONG_F +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + September 26, 2002 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_fclose_degree_f</strong><span class="sign">(</span>fapl_id<span class="sign">,</span> degree<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> fapl_id <span class="sign">!</span> File Access Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> degree <span class="sign">!</span> Possible values are<span class="sign">:</span> + <span class="sign">!</span> H5F_CLOSE_DEFAULT_F + <span class="sign">!</span> H5F_CLOSE_WEAK_F + <span class="sign">!</span> H5F_CLOSE_SEMI_F + <span class="sign">!</span> H5F_CLOSE_STRONG_F + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5ffill5ftime5ff"></a> +<a name="robo328"></a><h2>h5pset_fill_time_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_fill_time_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Set fill value writing time for dataset +</pre> +<p class="item_name">INPUTS</p> +<pre> plist_id - dataset creation property list identifier + flag - fill time flag: + H5D_FILL_TIME_ERROR_F + H5D_FILL_TIME_ALLOC_F + H5D_FILL_TIME_NEVER_F +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + October 4, 2002 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_fill_time_f</strong><span class="sign">(</span>plist_id<span class="sign">,</span> flag<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> plist_id <span class="sign">!</span> Dataset creation property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> flag <span class="sign">!</span> Fill time flag<span class="sign">:</span> + <span class="sign">!</span> H5D_FILL_TIME_ERROR_F + <span class="sign">!</span> H5D_FILL_TIME_ALLOC_F + <span class="sign">!</span> H5D_FILL_TIME_NEVER_F + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5ffilter5ff"></a> +<a name="robo329"></a><h2>h5pset_filter_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_filter_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Adds a filter to the filter pipeline. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - data creation or transfer property list + identifier + filter - filter to be added to the pipeline + flags - bit vector specifying certain general + properties of the filter + cd_nelmts - number of elements in cd_values + cd_values - auxiliary data for the filter +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + February, 2003 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_filter_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> filter<span class="sign">,</span> flags<span class="sign">,</span> cd_nelmts<span class="sign">,</span> cd_values<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> filter <span class="sign">!</span> Filter to be added to the pipeline<span class="sign">.</span> + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> flags <span class="sign">!</span> Bit vector specifying certain general + <span class="sign">!</span> properties of the filter<span class="sign">.</span> + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> cd_nelmts <span class="sign">!</span> Number of elements in cd_values<span class="sign">.</span> + INTEGER<span class="sign">,</span> DIMENSION<span class="comment">(*), INTENT(IN) :: cd_values ! Auxiliary data for the filter. + INTEGER, INTENT(OUT) :: hdferr ! Error code + ! 0 on success and -1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5ffletcher325ff"></a> +<a name="robo330"></a><h2>h5pset_fletcher32_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_fletcher32_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets Fletcher32 checksum of EDC for a dataset creation + property list. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - dataset creation property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + March 13, 2003 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_fletcher32_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5fgc5freferences5ff"></a> +<a name="robo331"></a><h2>h5pset_gc_references_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_gc_references_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets garbage collecting references flag. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - file access property list identifier + gc_reference - flag for stting garbage collection on + and off (1 or 0) +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_gc_references_f</strong> <span class="sign">(</span>prp_id<span class="sign">,</span> gc_reference<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> gc_reference <span class="sign">!</span> The flag <span class="keyword">for</span> garbage collecting + <span class="sign">!</span> references <span class="keyword">for</span> the file + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5fhyper5fvector5fsize5ff"></a> +<a name="robo332"></a><h2>h5pset_hyper_vector_size_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_hyper_vector_size_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Set the number of "I/O" vectors (vector size) +</pre> +<p class="item_name">INPUTS</p> +<pre> plist_id - dataset transfer property list identifier + size - vector size +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + October 7, 2002 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_hyper_vector_size_f</strong><span class="sign">(</span>plist_id<span class="sign">,</span> size<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> plist_id <span class="sign">!</span> Dataset transfer property list identifier + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> size <span class="sign">!</span> Vector size + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5fistore5fk5ff"></a> +<a name="robo335"></a><h2>h5pset_istore_k_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_istore_k_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets the size of the parameter used to control the + B-trees for indexing chunked datasets +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - file creation property list identifier + ik - 1/2 rank of chunked storage B-tree +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_istore_k_f</strong> <span class="sign">(</span>prp_id<span class="sign">,</span> ik<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> ik <span class="sign">!</span> 1<span class="sign">/</span>2 rank of chunked storage B<span class="sign">-</span>tree + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5flayout5ff"></a> +<a name="robo336"></a><h2>h5pset_layout_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_layout_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets the type of storage used store the raw data + for a dataset. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - data creation property list identifier + layout - type of storage layout for raw data + possible values are: + H5D_COMPACT_F + H5D_CONTIGUOUS_F + H5D_CHUNKED_F +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_layout_f</strong> <span class="sign">(</span>prp_id<span class="sign">,</span> layout<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> layout <span class="sign">!</span> Type of storage layout <span class="keyword">for</span> raw data + <span class="sign">!</span> possible values are<span class="sign">:</span> + <span class="sign">!</span> H5D_COMPACT_F + <span class="sign">!</span> H5D_CONTIGUOUS_F + <span class="sign">!</span> H5D_CHUNKED_F + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fH5Pset5flibver5fbounds5ff"></a> +<a name="robo337"></a><h2>H5Pset_libver_bounds_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>H5Pset_libver_bounds_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets bounds on library versions, and indirectly format versions, to be used when creating objects. +</pre> +<p class="item_name">INPUTS</p> +<pre> fapl_id - File access property list identifier + low - The earliest version of the library that will be used for writing objects. + high - The latest version of the library that will be used for writing objects. +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + February 18, 2008 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE h5pset_libver_bounds_f<span class="sign">(</span>fapl_id<span class="sign">,</span> low<span class="sign">,</span> high<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> fapl_id <span class="sign">!</span> File access property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> low <span class="sign">!</span> The earliest version of the library that will be used <span class="keyword">for</span> writing objects<span class="sign">.</span> + <span class="sign">!</span> Currently<span class="sign">,</span> low must be one of two pre<span class="sign">-</span>defined values<span class="sign">:</span> + <span class="sign">!</span> HDF_LIBVER_EARLIEST_F + <span class="sign">!</span> HDF_LIBVER_LATEST_F + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> high <span class="sign">!</span> The latest version of the library that will be used <span class="keyword">for</span> writing objects<span class="sign">.</span> + <span class="sign">!</span> Currently<span class="sign">,</span> low must set to the pre<span class="sign">-</span>defined value<span class="sign">:</span> + <span class="sign">!</span> HDF_LIBVER_LATEST_F + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fH5Pset5flink5fcreation5forder5ff"></a> +<a name="robo338"></a><h2>H5Pset_link_creation_order_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>H5Pset_link_creation_order_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets creation order tracking and indexing for links in a group. +</pre> +<p class="item_name">INPUTS</p> +<pre> gcpl_id - Group creation property list identifier + crt_order_flags - Creation order flag(s) +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - Error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + February 18, 2008 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE h5pset_link_creation_order_f<span class="sign">(</span>gcpl_id<span class="sign">,</span> crt_order_flags<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> gcpl_id <span class="sign">!</span> File access property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> crt_order_flags <span class="sign">!</span> Creation order flag<span class="sign">(</span>s<span class="sign">)</span> + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5flink5fphase5fchange5ff"></a> +<a name="robo339"></a><h2>h5pset_link_phase_change_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_link_phase_change_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets the parameters for conversion between compact and dense groups. +</pre> +<p class="item_name">INPUTS</p> +<pre> gcpl_id - Group creation property list identifier + max_compact - Maximum number of attributes to be stored in compact storage + min_dense - Minimum number of attributes to be stored in dense storage +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + March 21, 2008 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source">SUBROUTINE <strong>h5pset_link_phase_change_f</strong><span class="sign">(</span>gcpl_id<span class="sign">,</span> max_compact<span class="sign">,</span> min_dense<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> gcpl_id <span class="sign">!</span> Group creation property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> max_compact <span class="sign">!</span> Maximum number of attributes to be stored in compact storage + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> min_dense <span class="sign">!</span> Minimum number of attributes to be stored in dense storage + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fH5Pset5flocal5fheap5fsize5fhint5ff"></a> +<a name="robo340"></a><h2>H5Pset_local_heap_size_hint_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>H5Pset_local_heap_size_hint_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets the local heap size hint for original-style groups. +</pre> +<p class="item_name">INPUTS</p> +<pre> gcpl_id - Group creation property list identifier + size_hint - Hint for size of local heap +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - Error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + March 21, 2008 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE h5pset_local_heap_size_hint_f<span class="sign">(</span>gcpl_id<span class="sign">,</span> size_hint<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> gcpl_id <span class="sign">!</span> Group creation property list identifier + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> size_hint <span class="sign">!</span> Hint <span class="keyword">for</span> size of local heap + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fH5Pset5fnbit5ff"></a> +<a name="robo341"></a><h2>H5Pset_nbit_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>H5Pset_nbit_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets up the use of the N-Bit filter. +</pre> +<p class="item_name">INPUTS</p> +<pre> plist_id - Dataset creation property list identifier. +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - Error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + March 21, 2008 +</pre> +<p class="item_name">HISTORY</p> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE h5pset_nbit_f<span class="sign">(</span>plist_id<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> plist_id <span class="sign">!</span> Dataset creation property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5fnlinks5ff"></a> +<a name="robo342"></a><h2>h5pset_nlinks_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_nlinks_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets maximum number of soft or user-defined link traversals. +</pre> +<p class="item_name">INPUTS</p> +<pre> lapl_id - File access property list identifier + nlinks - Maximum number of links to traverse +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - Error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + March 24, 2008 +</pre> +<p class="item_name">HISTORY</p> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_nlinks_f</strong><span class="sign">(</span>lapl_id<span class="sign">,</span> nlinks<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> lapl_id <span class="sign">!</span> File access property list identifier + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> nlinks <span class="sign">!</span> Maximum number of links to traverse + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fH5Pset5fobj5ftrack5ftimes5ff"></a> +<a name="robo343"></a><h2>H5Pset_obj_track_times_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>H5Pset_obj_track_times_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Set whether the birth, access, modification & change times for + an object are stored. + + Birth time is the time the object was created. Access time is + the last time that metadata or raw data was read from this + object. Modification time is the last time the data for + this object was changed (either writing raw data to a dataset + or inserting/modifying/deleting a link in a group). Change + time is the last time the metadata for this object was written + (adding/modifying/deleting an attribute on an object, extending + the size of a dataset, etc). + + If these times are not tracked, they will be reported as + 12:00 AM UDT, Jan. 1, 1970 (i.e. 0 seconds past the UNIX + epoch) when queried. +</pre> +<p class="item_name">INPUTS</p> +<pre> plist_id - property list id + flag - object timestamp setting + .TRUE.,.FALSE. +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + February 22, 2008 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE h5pset_obj_track_times_f<span class="sign">(</span>plist_id<span class="sign">,</span> flag<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> plist_id <span class="sign">!</span> Dataset creation property + <span class="sign">!</span> list identifier + LOGICAL<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> flag <span class="sign">!</span> Object timestamp setting + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5fpreserve5ff"></a> +<a name="robo344"></a><h2>h5pset_preserve_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_preserve_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets the dataset transfer property list status to + TRUE or FALSE for initializing compound datatype + members during write/read operations. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - property list identifier + flag - status flag +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - Returns 0 if successful and -1 if fails +</pre> +<p class="item_name">OPTIONAL PARAMETERS</p> +<pre> NONE +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + + Datatype of the flag parameter is changed from + INTEGER to LOGICAL June 4, 2003 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_preserve_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> flag<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + LOGICAL<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> flag <span class="sign">!</span> TRUE<span class="sign">/</span>FALSE flag to set the dataset + <span class="sign">!</span> transfer property <span class="keyword">for</span> partila writing<span class="sign">/</span>reading + <span class="sign">!</span> compound datatype + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5fscaleoffset5ff"></a> +<a name="robo347"></a><h2>h5pset_scaleoffset_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_scaleoffset_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets up the use of the Scale-Offset filter. +</pre> +<p class="item_name">INPUTS</p> +<pre> plist_id - Dataset creation property list identifier. + scale_type - Flag indicating compression method. + scale_factor - Parameter related to scale. +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - Error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + March 21, 2008 +</pre> +<p class="item_name">HISTORY</p> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_scaleoffset_f</strong><span class="sign">(</span>plist_id<span class="sign">,</span> scale_type<span class="sign">,</span> scale_factor<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> plist_id <span class="sign">!</span> Dataset creation property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> scale_type <span class="sign">!</span> Flag indicating compression method<span class="sign">.</span> + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> scale_factor <span class="sign">!</span> Parameter related to scale<span class="sign">.</span> + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fH5Pset5fshared5fmesg5findex5ff"></a> +<a name="robo348"></a><h2>H5Pset_shared_mesg_index_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>H5Pset_shared_mesg_index_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Configures the specified shared object header message index +</pre> +<p class="item_name">INPUTS</p> +<pre> fcpl_id - File creation property list identifier. + index_num - Index being configured. + mesg_type_flags - Types of messages that should be stored in this index. + min_mesg_size - Minimum message size. +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + January, 2008 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE h5pset_shared_mesg_index_f<span class="sign">(</span>fcpl_id<span class="sign">,</span> index_num<span class="sign">,</span> mesg_type_flags<span class="sign">,</span> min_mesg_size<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> fcpl_id <span class="sign">!</span> file creation property list + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> index_num <span class="sign">!</span> Index being configured<span class="sign">.</span> + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> mesg_type_flags <span class="sign">!</span> Types of messages that should be stored in this index<span class="sign">.</span> + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> min_mesg_size <span class="sign">!</span> Minimum message size<span class="sign">.</span> + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fH5Pset5fshared5fmesg5fnindexes5ff"></a> +<a name="robo349"></a><h2>H5Pset_shared_mesg_nindexes_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>H5Pset_shared_mesg_nindexes_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets number of shared object header message indexes +</pre> +<p class="item_name">INPUTS</p> +<pre> plist_id - file creation property list + nindexes - Number of shared object header message indexes to be available in files created with this property list +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> M. Scot Breitenfeld + January, 2008 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE h5pset_shared_mesg_nindexes_f<span class="sign">(</span> plist_id<span class="sign">,</span> nindexes<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> plist_id <span class="sign">!</span> File creation property list + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> nindexes <span class="sign">!</span> Number of shared object header message indexes + <span class="sign">!</span> available in files created WITH this property list + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5fshuffle5ff"></a> +<a name="robo350"></a><h2>h5pset_shuffle_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_shuffle_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets shuffling filter +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - dataset creation property list identifier +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + March 12, 2003 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_shuffle_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5fsieve5fbuf5fsize5ff"></a> +<a name="robo351"></a><h2>h5pset_sieve_buf_size_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_sieve_buf_size_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets the maximum size of the data sieve buffer +</pre> +<p class="item_name">INPUTS</p> +<pre> plist_id - file access property list identifier + size - sieve buffer size +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + October 7, 2002 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_sieve_buf_size_f</strong><span class="sign">(</span>plist_id<span class="sign">,</span> size<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> plist_id <span class="sign">!</span> File access property list identifier + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> size <span class="sign">!</span> Buffer size in bytes<span class="sign">;</span> + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5fsizes5ff"></a> +<a name="robo352"></a><h2>h5pset_sizes_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_sizes_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets the byte size of the offsets and lengths used + to address objects in an <a href="./HDF5_f90.html#robo76">HDF5</a> file. +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - file creation property list identifier + sizeof_addr - size of an object offset in bytes + sizeof_size - size of an object length in bytes +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_sizes_f</strong> <span class="sign">(</span>prp_id<span class="sign">,</span> sizeof_addr<span class="sign">,</span> sizeof_size<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> sizeof_addr <span class="sign">!</span> Size of an object + <span class="sign">!</span> offset in bytes + INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> sizeof_size <span class="sign">!</span> Size of an object + <span class="sign">!</span> length in bytes + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5fsmall5fdata5fblock5fsize5ff"></a> +<a name="robo353"></a><h2>h5pset_small_data_block_size_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_small_data_block_size_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets the minimum size of "small" raw data block +</pre> +<p class="item_name">INPUTS</p> +<pre> plist_id - file access property list identifier + size - small raw data block size +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + October 7, 2002 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_small_data_block_size_f</strong><span class="sign">(</span>plist_id<span class="sign">,</span> size<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> plist_id <span class="sign">!</span> File access property list identifier + INTEGER<span class="sign">(</span>HSIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> size <span class="sign">!</span> Small raw data block size + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5fsym5fk5ff"></a> +<a name="robo354"></a><h2>h5pset_sym_k_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_sym_k_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets the size of parameters used to control the +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - file creation property list identifier + ik - symbol table tree rank + lk - symbol table node size +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 + +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_sym_k_f</strong> <span class="sign">(</span>prp_id<span class="sign">,</span> ik<span class="sign">,</span> lk<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> ik <span class="sign">!</span> Symbol table tree rank + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> lk <span class="sign">!</span> Symbol table node size + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5fszip5ff"></a> +<a name="robo355"></a><h2>h5pset_szip_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_szip_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets up use of szip compression +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - dataset creation property list identifier + options_mask - A bit-mask conveying the desired SZIP options. + Current valid values in Fortran are: + H5_SZIP_EC_OM_F + H5_SZIP_NN_OM_F + pixels_per_block - szip parameters +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + April 10 2003 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_szip_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> options_mask<span class="sign">,</span> pixels_per_block<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Dataset creation property + <span class="sign">!</span> list identifier + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> options_mask <span class="sign">!</span> A bit<span class="sign">-</span>mask conveying the desired + <span class="sign">!</span> SZIP options + <span class="sign">!</span> Current valid values in Fortran are<span class="sign">:</span> + <span class="sign">!</span> H5_SZIP_EC_OM_F + <span class="sign">!</span> H5_SZIP_NN_OM_F + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> pixels_per_block <span class="sign">!</span> The number of pixels or data elements + <span class="sign">!</span> in each data block + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5pset5fuserblock5ff"></a> +<a name="robo356"></a><h2>h5pset_userblock_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5pset_userblock_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Sets user block size +</pre> +<p class="item_name">INPUTS</p> +<pre> prp_id - file creation property list to modify + size - size of the user-block in bytes +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + August 12, 1999 +</pre> +<p class="item_name">HISTORY</p> +<pre> Explicit Fortran interfaces were added for + called C functions (it is needed for Windows + port). March 14, 2001 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5pset_userblock_f</strong> <span class="sign">(</span>prp_id<span class="sign">,</span> size<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier + INTEGER<span class="sign">(</span>HSIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> size <span class="sign">!</span> Size of the user<span class="sign">-</span>block in bytes + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +<hr /> +<a name="H5P2fh5punregister5ff"></a> +<a name="robo357"></a><h2>h5punregister_f</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p> +<p class="item_name">NAME</p> +<pre> <strong>h5punregister_f</strong> +</pre> +<p class="item_name">PURPOSE</p> +<pre> Removes a property from a property list class. +</pre> +<p class="item_name">INPUTS</p> +<pre> class - Property list class identifier + name - name of the property to remove +</pre> +<p class="item_name">OUTPUTS</p> +<pre> hdferr: - error code + Success: 0 + Failure: -1 +</pre> +<p class="item_name">AUTHOR</p> +<pre> Elena Pourmal + October 9, 2002 +</pre> +<p class="item_name">SOURCE</p> +<pre class="source"> SUBROUTINE <strong>h5punregister_f</strong><span class="sign">(</span>class<span class="sign">,</span> name<span class="sign">,</span> hdferr<span class="sign">)</span> + IMPLICIT NONE + INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> class <span class="sign">!</span> property list class identifier + CHARACTER<span class="sign">(</span>LEN<span class="sign">=</span><span class="sign">*</span><span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> name <span class="sign">!</span> name of property to remove + INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code + <span class="sign">!</span> 0 on success and <span class="sign">-</span>1 on failure +</pre> + +</div> <!-- content --> +<div id="footer"> +<p>Generated from ./src/H5Pff.f90 on Sun Aug 14 2011 22:49:38 +</p> +</div> <!-- footer --> +</body> +</html> |