From c340289304318d19864294c8a39f0d9b60f24c21 Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Fri, 5 Jul 2002 16:13:15 -0500 Subject: [svn-r5769] 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 --- doc/html/RM_H5Z.html | 39 ++++++++++++++++++++------------------- 1 file changed, 20 insertions(+), 19 deletions(-) diff --git a/doc/html/RM_H5Z.html b/doc/html/RM_H5Z.html index 7b24a40..9d0f93c 100644 --- a/doc/html/RM_H5Z.html +++ b/doc/html/RM_H5Z.html @@ -1,7 +1,9 @@ - +<head> +<title> HDF5/H5Z API Specification - + + @@ -85,31 +87,31 @@ data compression.
Signature:
herr_t H5Zregister(H5Z_method_t method, const char *name, - H5Z_func_tcfunc, - H5Z_func_t ufunc + H5Z_func_t function )
Purpose: -
Registers new compression and uncompression functions for a - method specified by a method number. +
Registers new compression / uncompression function.
Description: -
H5Zregister registers new compression and uncompression - functions for a method specified by a method number, method. - name is used for debugging and may be the null pointer. - Either or both of cfunc (the compression function) and - ufunc (the uncompression method) may be null pointers. +
H5Zregister registers a new compression / uncompression + function for the compression method specified by + the method number, method. +

+ name is used for debugging and may be the null pointer. +

+ function is a user-defined function providing both + compression and uncompression; it may be the null pointer.

The statistics associated with a method number are not reset by this function; they accumulate over the life of the library.

Parameters:
H5Z_method_t method -
Number specifying compression method. +
IN: Number specifying compression method.
const char *name -
Name associated with the method number. -
H5Z_func_t cfunc -
Compression method. -
H5Z_func_t ufunc -
Uncompression method. +
IN: Name associated with the method number. + Used for debugging purposes only. +
H5Z_func_t function +
IN: Compression / uncompression method.
Returns:
Returns a non-negative value if successful; @@ -157,10 +159,9 @@ H5Z   HDF Help Desk
-Last modified: 8 September 2000 +Last modified: 3 July 2002
Describes HDF5 Release 1.5, Unreleased Development Branch - -- cgit v0.12