From 7a91c29baa909ea4d1a79cf0d325d49c854734c9 Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Wed, 16 Jan 2002 13:45:29 -0500 Subject: [svn-r4837] Purpose: Bugfix. Copy edits. Description: Added IN/OUT designations to parameters. Copy edits. Removed () from public H5 functions in running text. Platforms tested: IE 5 --- doc/html/RM_H5E.html | 48 ++++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/doc/html/RM_H5E.html b/doc/html/RM_H5E.html index f9fb18e..428f998 100644 --- a/doc/html/RM_H5E.html +++ b/doc/html/RM_H5E.html @@ -120,11 +120,11 @@ As the functions unwind, additional entries are pushed onto the stack. The API function will return some indication that an error occurred and the application can print the error stack.

-Certain API functions in the H5E package, such as H5Eprint(), +Certain API functions in the H5E package, such as H5Eprint, do not clear the error stack. Otherwise, any function which does not have an underscore immediately after the package name -will clear the error stack. For instance, H5Fopen() -clears the error stack while H5F_open() does not. +will clear the error stack. For instance, H5Fopen +clears the error stack while H5F_open does not.

An error stack has a fixed maximum size. If this size is exceeded then the stack will be truncated and only the @@ -155,7 +155,7 @@ errors within the H5E package. as an argument.

When the library is first initialized the auto printing function - is set to H5Eprint() (cast appropriately) and + is set to H5Eprint (cast appropriately) and client_data is the standard error stream pointer, stderr.

@@ -164,9 +164,9 @@ errors within the H5E package.

Parameters:
H5E_auto_t func -
Function to be called upon an error condition. +
IN: Function to be called upon an error condition.
void *client_data -
Data passed to the error function. +
IN: Data passed to the error function.
Returns:
Returns a non-negative value if successful; @@ -199,10 +199,10 @@ errors within the H5E package.
Parameters:
H5E_auto_t * func -
Current setting for the function to be called upon an +
OUT: Current setting for the function to be called upon an error condition.
void **client_data -
Current setting for the data passed to the error function. +
OUT: Current setting for the data passed to the error function.
Returns:
Returns a non-negative value if successful; @@ -230,7 +230,7 @@ errors within the H5E package.
H5Eclear clears the error stack for the current thread.

The stack is also cleared whenever an API function is called, - with certain exceptions (for instance, H5Eprint()). + with certain exceptions (for instance, H5Eprint).

H5Eclear can fail if there are problems initializing the library. @@ -323,12 +323,12 @@ errors within the H5E package. HDF5-DIAG: Error detected in thread 0.

H5Eprint is a convenience function for - H5Ewalk() with a function that prints error messages. - Users are encouraged to write there own more specific error handlers. + H5Ewalk with a function that prints error messages. + Users are encouraged to write their own more specific error handlers.

Parameters:
FILE * stream -
File pointer, or stderr if NULL. +
IN: File pointer, or stderr if NULL.
Returns:
Returns a non-negative value if successful; @@ -401,11 +401,11 @@ errors within the H5E package.
Parameters:
H5E_direction_t direction -
Direction in which the error stack is to be walked. +
IN: Direction in which the error stack is to be walked.
H5E_walk_t func -
Function to be called for each error encountered. +
IN: Function to be called for each error encountered.
void * client_data -
Data to be passed with func. +
IN: Data to be passed with func.
Returns:
Returns a non-negative value if successful; @@ -437,8 +437,8 @@ errors within the H5E package.
H5Ewalk_cb is a default error stack traversal callback function that prints error messages to the specified output stream. It is not meant to be called directly but rather as an - argument to the H5Ewalk() function. - This function is called also by H5Eprint(). + argument to the H5Ewalk function. + This function is called also by H5Eprint. Application writers are encouraged to use this function as a model for their own error stack walking functions.

@@ -452,17 +452,17 @@ errors within the H5E package. information about a particular error.

client_data is the same pointer that was passed as the - client_data argument of H5Ewalk(). + client_data argument of H5Ewalk. It is expected to be a file pointer (or stderr if null).

Parameters:
int n -
Number of times this function has been called +
IN/OUT: Number of times this function has been called for this traversal of the stack.
H5E_error_t *err_desc -
Error description. +
OUT: Error description.
void *client_data -
A file pointer, or stderr if null. +
IN: A file pointer, or stderr if null.
Returns:
Returns a non-negative value if successful; @@ -493,7 +493,7 @@ errors within the H5E package.
Parameters:
H5E_major_t n -
Major error number. +
IN: Major error number.
Returns:
Returns a character string describing the error if successful. @@ -522,7 +522,7 @@ errors within the H5E package.
Parameters:
H5E_minor_t n -
Minor error number. +
IN: Minor error number.
Returns:
Returns a character string describing the error if successful. @@ -577,7 +577,7 @@ H5E   HDF Help Desk
-Last modified: 13 November 2000 +Last modified: 10 August 2001
Describes HDF5 Release 1.5, Unreleased Development Branch -- cgit v0.12