[svn-r6979]

Purpose:
    Make "New Functions and Tools" section easier to read.

Solution:
    Alphabetized functions and tools lists.
    Created table with function names on left, full syntax on right.

Platforms tested:
   Safari, IE 5
This commit is contained in:
Frank Baker 2003-06-05 16:42:16 -05:00
parent 0004209a24
commit e747ba6bed

View File

@ -50,177 +50,298 @@ Release 1.4.x versions of this document; they are not reported here.
<h3>New Functions and Tools</h3>
<dl>
<dt>The following functions are new for Release 1.5 and are included in the
<dt>The following functions are new for Release 1.5 and are included in the
<a href="../RM_H5Front.html"><cite>HDF5 Reference Manual</cite></a>.
<dd>&nbsp;</dd>
<dd><em>herr_t</em> <code><font color="red">H5Pset_filter</font></code>
(<em>hid_t</em> <code>plist</code>, <em>H5Z_filter_t</em> <code>filter</code>,
<em>unsigned int</em> <code>flags</code>, <em>size_t</em> <code>cd_nelmts</code>,
<em>const unsigned int</em> <code>cd_values[])</code>
</dd>
<dd>&nbsp;</dd>
<dd>
<em>herr_t</em> <code><font color="red">H5Pset_fletcher32</font></code> (<em>hid_t</em>
<code>plist</code>)
</dd>
<dd>
<em>herr_t</em> <code><font color="red">H5Pset_edc_check</font></code> (<em>hid_t</em>
<code>plist</code>, <em>H5Z_EDC_t</em> <code>check</code>)
</dd>
<dd>
<em>H5Z_EDC_t</em> <code><font color="red">H5Pget_edc_check</font></code> (<em>hid_t</em>
<code>plist</code>)
</dd>
<dd>
<em>herr_t</em> <code><font color="red">H5Pset_filter_callback</font></code> (<em>hid_t</em>
<code>plist</code>, <em>H5Z_filter_func_t</em> <code>func</code>,
<em>void *</em><code>op_data</code>)
</dd>
<dd>
<em>hid_t</em> <code><font color="red">H5Dget_space_status</font></code> (<em>hid_t</em>
<table border="0">
<tr>
<td align="left" valign="top"><code>H5Dget_offset</code></td>
<td align="left" valign="top"><em>hsize_t</em> <code>H5Dget_offset</code> (<em>hid_t </em><code>dset_id</code>)</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Dget_space_status</code></td>
<td align="left" valign="top"><em>hid_t</em> <code>H5Dget_space_status</code> (<em>hid_t</em>
<code>dset_id</code>, <em>H5D_space_status_t *</em><code>status</code>)
</dd>
<dd>
<em>herr_t </em><code><font color="red">H5Pset_alloc_time</font></code> (<em>hid_t</em>
<code>plist_id</code>, <em>H5D_alloc_time_t</em> <code>alloc_time</code>)
</dd>
<dd>
<em>herr_t </em><code><font color="red">H5Pget_alloc_time</font></code> (<em>hid_t</em> <code>plist_id</code>,
<em>H5D_alloc_time_t *</em><code>alloc_time</code>)
</dd>
<dd>
<em>herr_t </em><code><font color="red">H5Pset_fill_time</font></code> (<em>hid_t</em> <code>plist_id</code>,
<em>H5D_fill_time_t</em> <code>fill_time</code>)
</dd>
<dd>
<em>herr_t </em><code><font color="red">H5Pget_fill_time</font></code> (<em>hid_t</em> <code>plist_id</code>,
<em>H5D_fill_time_t *</em><code>fill_time</code>)
</dd>
<dd>
<em>herr_t </em><code><font color="red">H5Pfill_value_defined</font></code> (<em>hid_t</em> <code>plist_id</code>,
</td>
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Fget_obj_ids</code></td>
<td align="left" valign="top">
<em>herr_t </em><code>H5Fget_obj_ids</code> (<em>hid_t</em> <code>file_id</code>,
<em>unsigned int</em> <code>types</code>, <em>hid_t *</em><code>obj_id_list</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Fget_vfd_handle</code></td>
<td align="left" valign="top">
<em>herr_t </em><code>H5Fget_vfd_handle</code> (<em>hid_t</em> <code>file_id</code>,
<em>hid_t</em> <code>fapl_id</code>, <em>void *</em><code>file_handle</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Gget_num_objs</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Gget_num_objs</code> (<em>hid_t</em> <code>loc_id</code>,
<em>hsize_t* </em> <code>num_obj</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Gget_objname_by_idx</code></td>
<td align="left" valign="top">
<em>ssize_t</em> <code>H5Gget_objname_by_idx</code> (<em>hid_t</em> <code>group_id</code>,
<em>hsize_t</em> <code>idx</code>, <em>char *</em><code>name</code>,
<em>size_t*</em> <code>size</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Gget_objtype_by_idx</code></td>
<td align="left" valign="top">
<em>int</em> <code>H5Gget_objtype_by_idx</code> (<em>hid_t</em> <code>group_id</code>,
<em>hsize_t</em> <code>idx</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Iget_name</code></td>
<td align="left" valign="top">
<em>ssize_t</em> <code>H5Iget_name</code> (<em>hid_t</em> <code>obj_id</code>,
<em>char *</em><code>name</code>, <em>size_t</em> <code>size</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pall_filters_avail</code></td>
<td align="left" valign="top">
<em>htri_t</em> <code>H5Pall_filters_avail</code> (<em>hid_t</em> <code>dcpl_id</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pfill_value_defined</code></td>
<td align="left" valign="top">
<em>herr_t </em><code>H5Pfill_value_defined</code> (<em>hid_t</em> <code>plist_id</code>,
<em>H5D_fill_value_t *</em><code>status</code>)
</dd>
<dd>
<em>herr_t</em> <code><font color="red">H5Pset_shuffle</font></code> (<em>hid_t</em> <code>plist_id</code>)
</dd>
<dd>
<em>herr_t</em> <code><font color="red">H5Zfilter_avail</font></code> (<em>H5Z_filter_t</em> <code>filter</code>)
</dd>
<dd>
<em>herr_t</em> <code><font color="red">H5Zunregister</font></code> (<em>H5Z_filter_t</em> <code>filter</code>)
</dd>
<dd>
<em>herr_t</em> <code><font color="red">H5Pmodify_filter</font></code> (<em>hid_t</em> <code>plist</code>,
<em>H5Z_filter_t</em> <code>filter</code>, <em>unsigned int</em> <code>flags</code>,
<em>size_t</em> <code>cd_nelmts</code>, <em>const unsigned int</em> <code>cd_values[]</code>)
</dd>
<dd>
<em>herr_t</em> <code><font color="red">H5Pget_filter_by_id</font></code> (<em>hid_t</em> <code>plist_id</code>,
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pget_alloc_time</code></td>
<td align="left" valign="top">
<em>herr_t </em><code>H5Pget_alloc_time</code> (<em>hid_t</em> <code>plist_id</code>,
<em>H5D_alloc_time_t *</em><code>alloc_time</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pget_edc_check</code></td>
<td align="left" valign="top">
<em>H5Z_EDC_t</em> <code>H5Pget_edc_check</code> (<em>hid_t</em>
<code>plist</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pget_family_offset</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pget_family_offset</code> (<em>hid_t</em> <code>fapl_id</code>,
<em>hsize_t *</em><code>offset</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pget_fapl_mpiposix</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pget_fapl_mpiposix</code> (<em>hid_t</em> <code>fapl_id</code>,
<em>MPI_Comm *</em><code>comm</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pget_fill_time</code></td>
<td align="left" valign="top">
<em>herr_t </em><code>H5Pget_fill_time</code> (<em>hid_t</em> <code>plist_id</code>,
<em>H5D_fill_time_t *</em><code>fill_time</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pget_filter_by_id</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pget_filter_by_id</code> (<em>hid_t</em> <code>plist_id</code>,
<em>H5Z_filter_t</em> <code>filter</code>, <em>unsigned int *</em><code>flags</code>,
<em>size_t *</em><code>cd_nelmts</code>, <em>unsigned int</em> <code>cd_values[]</code>,
<em>size_t</em> <code>namelen</code>, <em>char *</em><code>name[]</code>)
</dd>
<dd>
<em>htri_t</em> <code><font color="red">H5Pall_filters_avail</font></code> (<em>hid_t</em> <code>dcpl_id</code>)
</dd>
<dd>
<em>herr_t</em> <code><font color="red">H5Pset_szip</font></code> (<em>hid_t</em> <code>plist</code>,
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pget_hyper_vector_size</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pget_hyper_vector_size</code> (<em>hid_t</em> <code>dxpl_id</code>,
<em>size_t *</em><code>vector_size</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pget_multi_type</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pget_multi_type</code> (<em>hid_t</em> <code>fapl_id</code>,
<em>H5FD_mem_t *</em><code>type</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pmodify_filter</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pmodify_filter</code> (<em>hid_t</em> <code>plist</code>,
<em>H5Z_filter_t</em> <code>filter</code>, <em>unsigned int</em> <code>flags</code>,
<em>size_t</em> <code>cd_nelmts</code>, <em>const unsigned int</em> <code>cd_values[]</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pset_alloc_time</code></td>
<td align="left" valign="top">
<em>herr_t </em><code>H5Pset_alloc_time</code> (<em>hid_t</em>
<code>plist_id</code>, <em>H5D_alloc_time_t</em> <code>alloc_time</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pset_edc_check</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pset_edc_check</code> (<em>hid_t</em>
<code>plist</code>, <em>H5Z_EDC_t</em> <code>check</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pset_family_offset</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pset_family_offset</code> (<em>hid_t</em> <code>fapl_id</code>,
<em>hsize_t</em> <code>offset</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pset_fapl_mpiposix</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pset_fapl_mpiposix</code> (<em>hid_t</em> <code>fapl_id</code>,
<em>MPI_Comm</em> <code>comm</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pset_fill_time</code></td>
<td align="left" valign="top">
<em>herr_t </em><code>H5Pset_fill_time</code> (<em>hid_t</em> <code>plist_id</code>,
<em>H5D_fill_time_t</em> <code>fill_time</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pset_filter</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pset_filter</code>
(<em>hid_t</em> <code>plist</code>, <em>H5Z_filter_t</em> <code>filter</code>,
<em>unsigned int</em> <code>flags</code>, <em>size_t</em> <code>cd_nelmts</code>,
<em>const unsigned int</em> <code>cd_values[])</code>
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pset_filter_callback</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pset_filter_callback</code> (<em>hid_t</em>
<code>plist</code>, <em>H5Z_filter_func_t</em> <code>func</code>,
<em>void *</em><code>op_data</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pset_fletcher32</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pset_fletcher32</code> (<em>hid_t</em>
<code>plist</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pset_hyper_vector_size</code>&nbsp;</td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pset_hyper_vector_size</code> (<em>hid_t</em> <code>dxpl_id</code>,
<em>size_t</em> <code>vector_size</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pset_multi_type</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pset_multi_type</code> (<em>hid_t</em> <code>fapl_id</code>,
<em>H5FD_mem_t</em> <code>type</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pset_shuffle</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pset_shuffle</code> (<em>hid_t</em> <code>plist_id</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pset_szip</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pset_szip</code> (<em>hid_t</em> <code>plist</code>,
<em>unsigned int</em> <code>options_mask</code>, <em>unsigned int</em>
<code>pixels_per_block</code>)
</dd>
<dd>
<em>H5S_sel_type</em> <code><font color="red">H5Sget_select_type</font></code> (<em>hid_t</em> <code>space_id</code>)
</dd>
<dd>
<em>ssize_t</em> <code><font color="red">H5Iget_name</font></code> (<em>hid_t</em> <code>obj_id</code>,
<em>char *</em><code>name</code>, <em>size_t</em> <code>size</code>)
</dd>
<dd>
<em>herr_t</em> <code><font color="red">H5set_free_list_limits</font></code> (<em>int</em> <code>reg_global_lim</code>,
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Rget_object_type</code></td>
<td align="left" valign="top">
<em>int</em> <code>H5Rget_object_type</code> (<em>hid_t</em> <code>id</code>,
<em>void *</em><code>ref</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5set_free_list_limits</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5set_free_list_limits</code> (<em>int</em> <code>reg_global_lim</code>,
<em>int</em> <code>reg_list_lim</code>, <em>int</em> <code>arr_global_lim</code>,
<em>int</em> <code>arr_list_lim</code>, <em>int</em> <code>blk_global_lim</code>,
<em>int</em> <code>blk_list_lim</code>)
</dd>
<dd>
<em>hsize_t </em><code><font color="red">H5Dget_offset</font></code> (<em>hid_t </em><code>dset_id</code>)
</dd>
<dd>
<em>herr_t </em><code><font color="red">H5Fget_vfd_handle</font></code> (<em>hid_t</em> <code>file_id</code>,
<em>hid_t</em> <code>fapl_id</code>, <em>void *</em><code>file_handle</code>)
</dd>
<dd>
<em>herr_t </em><code><font color="red">H5Fget_obj_ids</font></code> (<em>hid_t</em> <code>file_id</code>,
<em>unsigned int</em> <code>types</code>, <em>hid_t *</em><code>obj_id_list</code>)
</dd>
<dd>
<em>herr_t</em> <code><font color="red">H5Gget_num_objs</font></code> (<em>hid_t</em> <code>loc_id</code>,
<em>hsize_t* </em> <code>num_obj</code>)
</dd>
<dd>
<em>ssize_t</em> <code><font color="red">H5Gget_objname_by_idx</font></code> (<em>hid_t</em> <code>group_id</code>,
<em>hsize_t</em> <code>idx</code>, <em>char *</em><code>name</code>,
<em>size_t*</em> <code>size</code>)
</dd>
<dd>
<em>int</em> <code><font color="red">H5Gget_objtype_by_idx</font></code> (<em>hid_t</em> <code>group_id</code>,
<em>hsize_t</em> <code>idx</code>)
</dd>
<dd>
<em>herr_t</em> <code><font color="red">H5Pset_family_offset</font></code> (<em>hid_t</em> <code>fapl_id</code>,
<em>hsize_t</em> <code>offset</code>)
</dd>
<dd>
<em>herr_t</em> <code><font color="red">H5Pget_family_offset</font></code> (<em>hid_t</em> <code>fapl_id</code>,
<em>hsize_t *</em><code>offset</code>)
</dd>
<dd>
<em>herr_t</em> <code><font color="red">H5Pset_multi_type</font></code> (<em>hid_t</em> <code>fapl_id</code>,
<em>H5FD_mem_t</em> <code>type</code>)
</dd>
<dd>
<em>herr_t</em> <code><font color="red">H5Pget_multi_type</font></code> (<em>hid_t</em> <code>fapl_id</code>,
<em>H5FD_mem_t *</em><code>type</code>)
</dd>
<dd>
<em>herr_t</em> <code><font color="red">H5Pset_fapl_mpiposix</font></code> (<em>hid_t</em> <code>fapl_id</code>,
<em>MPI_Comm</em> <code>comm</code>)
</dd>
<dd>
<em>herr_t</em> <code><font color="red">H5Pget_fapl_mpiposix</font></code> (<em>hid_t</em> <code>fapl_id</code>,
<em>MPI_Comm *</em><code>comm</code>)
</dd>
<dd>
<em>herr_t</em> <code><font color="red">H5Pset_hyper_vector_size</font></code> (<em>hid_t</em> <code>dxpl_id</code>,
<em>size_t</em> <code>vector_size</code>)
</dd>
<dd>
<em>herr_t</em> <code><font color="red">H5Pget_hyper_vector_size</font></code> (<em>hid_t</em> <code>dxpl_id</code>,
<em>size_t *</em><code>vector_size</code>)
</dd>
<dd>
<em>int</em> <code><font color="red">H5Rget_object_type</font></code> (<em>hid_t</em> <code>id</code>,
<em>void *</em><code>ref</code> )
</dd>
<dd>
<em>hid_t</em> <code><font color="red">H5Tget_native_type</font></code> (<em>hid_t</em> <code>type_id</code>,
<em>H5T_direction_t</em> <code>direction</code>)
</dd>
<dd>
<em>htri_t </em><code><font color="red">H5Tis_variable_str</font></code> (<em>hid_t </em><code>dtype_id</code>)
</dd>
<dd>
<em>htri_t </em><code><font color="red">H5Tdetect_class</font></code> (<em>hid_t</em> <code>dtype_id</code>,
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Sget_select_type</code></td>
<td align="left" valign="top">
<em>H5S_sel_type</em> <code>H5Sget_select_type</code> (<em>hid_t</em> <code>space_id</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Tdetect_class</code></td>
<td align="left" valign="top">
<em>htri_t </em><code>H5Tdetect_class</code> (<em>hid_t</em> <code>dtype_id</code>,
<em>H5T_class_t</em> <code>dtype_class</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Tget_native_type</code></td>
<td align="left" valign="top">
<em>hid_t</em> <code>H5Tget_native_type</code> (<em>hid_t</em> <code>type_id</code>,
<em>H5T_direction_t</em> <code>direction</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Tis_variable_str</code></td>
<td align="left" valign="top">
<em>htri_t </em><code>H5Tis_variable_str</code> (<em>hid_t </em><code>dtype_id</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Zfilter_avail</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Zfilter_avail</code> (<em>H5Z_filter_t</em> <code>filter</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Zunregister</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Zunregister</code> (<em>H5Z_filter_t</em> <code>filter</code>)
</td>
</tr>
</table>
</dd>
<dd>&nbsp;</dd>
</dt>
<dt>The following tools are new for Release 1.5 and are included in the
<a href="../RM_H5Front.html"><cite>HDF5 Reference Manual</cite></a>.
<dd>&nbsp;</dd>
<dd><code><font color="red">h5import</font></code>
<dd><code><font color="red">h5fc</font></code>
<dd><code><font color="red">h5perf</font></code>
<dd><code><font color="red">h5redeploy</font></code>
<dd><code>h5import</code>
<dd><code>h5fc</code>
<dd><code>h5perf</code>
<dd><code>h5redeploy</code>
</dt>
</dl>
@ -550,7 +671,7 @@ Describes HDF5 Release 1.5, Unreleased Development Branch
<!-- Created: Spring 1999 -->
<!-- hhmts start -->
Last modified: 25 January 2002
Last modified: 5 June 2003
<!-- hhmts end -->
</body>