mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2025-03-25 17:00:45 +08:00
Code Issues Packages Projects Releases Wiki Activity

[svn-r5769]

Browse Source 
Purpose:
    Bugfix
Description:
    Corrected H5Zregister description, syntax, and parameter descriptions.
    There is one 'function' parameter, rather than the separate
     'compression-function' and 'uncompression-function' parameters that
     were previously listed.
Platforms tested:
    IE 5
This commit is contained in:
Frank Baker 2002-07-05 16:13:15 -05:00
parent a7f785ade0
commit c340289304
1 changed files with 20 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
doc/html/RM_H5Z.html
View File

@ -1,7 +1,9 @@
<html>
<head><title>
<head>
<title>
HDF5/H5Z API Specification
</title></head>
</title>
</head>
<body bgcolor="#FFFFFF">
@ -85,31 +87,31 @@ data compression.
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Zregister</code>(<em>H5Z_method_t</em> <code>method</code>,
<em>const char *</em><code>name</code>,
<em>H5Z_func_t</em><code>cfunc</code>,
<em>H5Z_func_t</em> <code>ufunc</code>
<em>H5Z_func_t</em> <code>function</code>
)
<dt><strong>Purpose:</strong>
<dd> Registers new compression and uncompression functions for a
method specified by a method number.
<dd> Registers new compression / uncompression function.
<dt><strong>Description:</strong>
<dd><code>H5Zregister</code> registers new compression and uncompression
functions for a method specified by a method number, <code>method</code>.
<code>name</code> is used for debugging and may be the null pointer.
Either or both of <code>cfunc</code> (the compression function) and
<code>ufunc</code> (the uncompression method) may be null pointers.
<dd><code>H5Zregister</code> registers a new compression / uncompression
function for the compression method specified by
the method number, <code>method</code>.
<p>
<code>name</code> is used for debugging and may be the null pointer.
<p>
<code>function</code> is a user-defined function providing both
compression and uncompression; it may be the null pointer.
<p>
The statistics associated with a method number are not reset
by this function; they accumulate over the life of the library.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>H5Z_method_t</em> <code>method</code>
<dd>Number specifying compression method.
<dd>IN: Number specifying compression method.
<dt><em>const char *</em><code>name</code>
<dd>Name associated with the method number.
<dt><em>H5Z_func_t</em> <code>cfunc</code>
<dd>Compression method.
<dt><em>H5Z_func_t</em> <code>ufunc</code>
<dd>Uncompression method.
<dd>IN: Name associated with the method number.
Used for debugging purposes only.
<dt><em>H5Z_func_t</em> <code>function</code>
<dd>IN: Compression / uncompression method.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
@ -157,10 +159,9 @@ H5Z&nbsp;&nbsp;
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
<br>
Last modified: 8 September 2000
Last modified: 3 July 2002
<br>
Describes HDF5 Release 1.5, Unreleased Development Branch
</body>
</html>