diff options
| author | Quincey Koziol <koziol@hdfgroup.org> | 1998-10-26 21:18:54 (GMT) |
|---|---|---|
| committer | Quincey Koziol <koziol@hdfgroup.org> | 1998-10-26 21:18:54 (GMT) |
| commit | 69d3cf72b3498e4f6ee95425881cf227f7f71c93 (patch) | |
| tree | 686a04bfbdced05835ec3d075a367c95c96cab3f /src | |
| parent | 4d5f1b72de9f2439904975da411dea4f8095fe7b (diff) | |
| download | hdf5-69d3cf72b3498e4f6ee95425881cf227f7f71c93.zip hdf5-69d3cf72b3498e4f6ee95425881cf227f7f71c93.tar.gz hdf5-69d3cf72b3498e4f6ee95425881cf227f7f71c93.tar.bz2 | |
[svn-r797] Changed comments from returning "SUCCEED/FAIL" to "non-negative/negative"
and also fixed a few more explicit checks against FAIL.
Diffstat (limited to 'src')
| -rw-r--r-- | src/H5.c | 35 | ||||
| -rw-r--r-- | src/H5A.c | 26 | ||||
| -rw-r--r-- | src/H5AC.c | 28 | ||||
| -rw-r--r-- | src/H5B.c | 53 | ||||
| -rw-r--r-- | src/H5D.c | 44 | ||||
| -rw-r--r-- | src/H5Distore.c | 84 | ||||
| -rw-r--r-- | src/H5E.c | 40 | ||||
| -rw-r--r-- | src/H5F.c | 54 | ||||
| -rw-r--r-- | src/H5Farray.c | 12 | ||||
| -rw-r--r-- | src/H5Fcore.c | 16 | ||||
| -rw-r--r-- | src/H5Ffamily.c | 16 | ||||
| -rw-r--r-- | src/H5Fistore.c | 84 | ||||
| -rw-r--r-- | src/H5Flow.c | 28 | ||||
| -rw-r--r-- | src/H5Fmpio.c | 28 | ||||
| -rw-r--r-- | src/H5Fsec2.c | 12 | ||||
| -rw-r--r-- | src/H5Fsplit.c | 25 | ||||
| -rw-r--r-- | src/H5Fstdio.c | 16 | ||||
| -rw-r--r-- | src/H5G.c | 91 | ||||
| -rw-r--r-- | src/H5Gent.c | 24 | ||||
| -rw-r--r-- | src/H5Gnode.c | 28 | ||||
| -rw-r--r-- | src/H5Gstab.c | 16 | ||||
| -rw-r--r-- | src/H5HG.c | 20 | ||||
| -rw-r--r-- | src/H5HL.c | 20 | ||||
| -rw-r--r-- | src/H5I.c | 18 | ||||
| -rw-r--r-- | src/H5MF.c | 12 | ||||
| -rw-r--r-- | src/H5O.c | 58 | ||||
| -rw-r--r-- | src/H5Oattr.c | 8 | ||||
| -rw-r--r-- | src/H5Ocomp.c | 12 | ||||
| -rw-r--r-- | src/H5Ocont.c | 8 | ||||
| -rw-r--r-- | src/H5Odtype.c | 24 | ||||
| -rw-r--r-- | src/H5Oefl.c | 20 | ||||
| -rw-r--r-- | src/H5Ofill.c | 16 | ||||
| -rw-r--r-- | src/H5Olayout.c | 8 | ||||
| -rw-r--r-- | src/H5Omtime.c | 8 | ||||
| -rw-r--r-- | src/H5Oname.c | 14 | ||||
| -rw-r--r-- | src/H5Osdspace.c | 8 | ||||
| -rw-r--r-- | src/H5Oshared.c | 8 | ||||
| -rw-r--r-- | src/H5Ostab.c | 8 | ||||
| -rw-r--r-- | src/H5P.c | 192 | ||||
| -rw-r--r-- | src/H5R.c | 14 | ||||
| -rw-r--r-- | src/H5RA.c | 36 | ||||
| -rw-r--r-- | src/H5S.c | 64 | ||||
| -rw-r--r-- | src/H5Sall.c | 10 | ||||
| -rw-r--r-- | src/H5Shyper.c | 44 | ||||
| -rw-r--r-- | src/H5Spoint.c | 16 | ||||
| -rw-r--r-- | src/H5Sselect.c | 26 | ||||
| -rw-r--r-- | src/H5T.c | 170 | ||||
| -rw-r--r-- | src/H5TB.c | 10 | ||||
| -rw-r--r-- | src/H5Tbit.c | 2 | ||||
| -rw-r--r-- | src/H5Tconv.c | 39 | ||||
| -rw-r--r-- | src/H5V.c | 32 | ||||
| -rw-r--r-- | src/H5Z.c | 20 |
52 files changed, 536 insertions, 1169 deletions
@@ -88,7 +88,7 @@ USAGE herr_t H5_init_library() RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Initializes any library-global data or routines. @@ -154,7 +154,7 @@ H5_init_library(void) void (*func)(void); IN: Function pointer of routine to add to chain RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Pre-pend the new function to the list of function to call during the exit process. These routines are responsible for free'ing static buffers, etc. @@ -193,7 +193,7 @@ H5_add_exit(void (*func)(void)) USAGE void H5_term_library() RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Walk through the shutdown routines for the various interfaces and terminate them all. @@ -224,7 +224,7 @@ USAGE void H5_init_thread() RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Initializes any thread-specific data or routines. @@ -250,7 +250,7 @@ H5_init_thread(void) USAGE void H5_term_thread() RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Release the error stack and any other thread-specific resources allocated on a "per thread" basis. @@ -271,7 +271,7 @@ USAGE herr_t H5_init_interface() RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Initializes any interface-specific data or routines. @@ -292,7 +292,7 @@ H5_init_interface(void) USAGE herr_t H5dont_atexit(void) RETURNS - Returns SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION This routine indicates to the library that an 'atexit()' cleanip routine should not be installed. The major (only?) purpose for this is in @@ -417,9 +417,8 @@ H5_debug_mask(const char *s) * printf("%u.%u.%u", maj, min, rel) or * printf("version %u.%u release %u", maj, min, rel) * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: + * Non-negative on success/Negative on failure * * Programmer: Unknown * @@ -496,9 +495,8 @@ H5check_version (unsigned majnum, unsigned minnum, unsigned relnum) * is failing inexplicably, then try calling this function * first. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: + * Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, December 9, 1997 @@ -521,9 +519,8 @@ H5open(void) * * Purpose: Terminate the library and release all resources. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: + * Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, January 30, 1998 @@ -1335,8 +1332,8 @@ H5_trace (hbool_t returning, const char *func, const char *type, ...) } } else { herr_t status = va_arg (ap, herr_t); - if (SUCCEED==status) fprintf (out, "SUCCEED"); - else if (FAIL==status) fprintf (out, "FAIL"); + if (status>=0) fprintf (out, "SUCCEED"); + else if (status<0) fprintf (out, "FAIL"); else fprintf (out, "%d", (int)status); } break; @@ -1573,7 +1570,7 @@ H5_trace (hbool_t returning, const char *func, const char *type, ...) hid_t obj = va_arg (ap, hid_t); if (-2 == obj) { fprintf (out, "H5P_DEFAULT"); - } else if (FAIL==obj) { + } else if (obj<0) { fprintf (out, "FAIL"); } else { switch (H5I_get_type (obj)) { @@ -55,7 +55,7 @@ USAGE herr_t H5A_init_interface() RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Initializes any interface-specific data or routines. @@ -94,7 +94,7 @@ H5A_init_interface(void) USAGE void H5A_term_interface() RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Release any other resources allocated. GLOBAL VARIABLES @@ -123,7 +123,7 @@ H5A_term_interface(void) hid_t space_id; IN: ID of dataspace for attribute hid_t plist_id; IN: ID of creation property list (currently not used) RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure ERRORS @@ -210,7 +210,7 @@ H5Acreate(hid_t loc_id, const char *name, hid_t type_id, hid_t space_id, * H5T_t *type; IN: Datatype of attribute * H5S_t *space; IN: Dataspace of attribute * - * Return: SUCCEED/FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Quincey Koziol * April 2, 1998 @@ -486,7 +486,7 @@ H5Aopen_idx(hid_t loc_id, unsigned idx) * const H5G_entry_t *ent; IN: Pointer to symbol table entry for object to attribute * unsigned idx; IN: index of attribute to open (0-based) * - * Return: SUCCEED/FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Quincey Koziol * April 2, 1998 @@ -548,7 +548,7 @@ done: hid_t type_id; IN: Memory datatype of buffer void *buf; IN: Buffer of data to write RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure ERRORS @@ -599,7 +599,7 @@ H5Awrite(hid_t attr_id, hid_t type_id, void *buf) const H5T_t *mem_type; IN: Memory datatype of buffer void *buf; IN: Buffer of data to write RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure ERRORS @@ -719,7 +719,7 @@ done: hid_t type_id; IN: Memory datatype of buffer void *buf; IN: Buffer for data to read RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure ERRORS @@ -770,7 +770,7 @@ H5Aread(hid_t attr_id, hid_t type_id, void *buf) const H5T_t *mem_type; IN: Memory datatype of buffer void *buf; IN: Buffer for data to read RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure ERRORS @@ -1205,7 +1205,7 @@ H5Aiterate(hid_t loc_id, unsigned *attr_num, H5A_operator_t op, void *op_data) hid_t loc_id; IN: Object (dataset or group) to have attribute deleted from const char *name; IN: Name of attribute to delete RETURNS - 0 on success, negative on failure + Non-negative on success/Negative on failure ERRORS @@ -1283,7 +1283,7 @@ H5Adelete(hid_t loc_id, const char *name) herr_t H5Aclose (attr_id) hid_t attr_id; IN: Attribute to release access to RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure ERRORS @@ -1371,9 +1371,7 @@ H5A_copy(const H5A_t *old_attr) * * Purpose: Frees a attribute and all associated memory. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, December 8, 1997 @@ -52,7 +52,7 @@ static H5AC_t *current_cache_g = NULL; /*for sorting */ * * Return: Success: Number of slots actually used. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * matzke@llnl.gov @@ -94,9 +94,7 @@ H5AC_create(H5F_t *f, intn size_hint) * This function fails if any object are protected since the * resulting file might not be consistent. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -329,10 +327,8 @@ H5AC_compare(const void *_a, const void *_b) * However, an attempt will be made to flush all non-protected * items before this function returns failure. * - * Return: Success: SUCCEED - * - * Failure: FAIL if there was a request to flush all - * items and something was protected. + * Return: Non-negative on success/Negative on failure if there was a + * request to flush all items and something was protected. * * Programmer: Robb Matzke * matzke@llnl.gov @@ -457,9 +453,7 @@ H5AC_flush(H5F_t *f, const H5AC_class_t *type, const haddr_t *addr, * If H5AC_DEBUG is defined then this function checks * that the object being inserted isn't a protected object. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -527,9 +521,7 @@ H5AC_set(H5F_t *f, const H5AC_class_t *type, const haddr_t *addr, void *thing) * that the old and new addresses don't correspond to the * address of a protected object. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -745,9 +737,7 @@ H5AC_protect(H5F_t *f, const H5AC_class_t *type, const haddr_t *addr, * if the TYPE and ADDR arguments are not what was used when the * object was protected or if the object was never protected. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -831,9 +821,7 @@ H5AC_unprotect(H5F_t *f, const H5AC_class_t *type, const haddr_t *addr, * * Purpose: Prints debugging info about the cache. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, October 30, 1997 @@ -149,10 +149,8 @@ static hbool_t interface_initialize_g = FALSE; * passed as an argument to the sizeof_rkey() method for the * B-tree. * - * Return: Success: SUCCEED, address of new node is returned - * through the RETVAL argument. - * - * Failure: FAIL + * Return: Non-negative on success (address of new node is returned + * through the RETVAL argument.) /Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -378,9 +376,7 @@ H5B_load(H5F_t *f, const haddr_t *addr, const void *_type, void *udata) * * Purpose: Flushes a dirty B-tree node to disk. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -493,10 +489,9 @@ H5B_flush(H5F_t *f, hbool_t destroy, const haddr_t *addr, H5B_t *bt) * pointers since it assumes that all nodes can be reached * from the parent node. * - * Return: Success: SUCCEED if found, values returned through the - * UDATA argument. - * - * Failure: FAIL if not found, UDATA is undefined. + * Return: Non-negative on success (if found, values returned through the + * UDATA argument.) /Negative on failure (if not found, UDATA is + * undefined.) * * Programmer: Robb Matzke * matzke@llnl.gov @@ -593,10 +588,8 @@ H5B_find(H5F_t *f, const H5B_class_t *type, const haddr_t *addr, void *udata) * The OLD_BT argument is a pointer to a protected B-tree * node. * - * Return: Success: SUCCEED. The address of the new node is - * returned through the NEW_ADDR argument. - * - * Failure: FAIL + * Return: Non-negative on success (The address of the new node is + * returned through the NEW_ADDR argument.) /Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -756,9 +749,7 @@ H5B_split(H5F_t *f, const H5B_class_t *type, H5B_t *old_bt, * * Purpose: Decode the specified key into native format. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -787,9 +778,7 @@ H5B_decode_key(H5F_t *f, H5B_t *bt, intn idx) * * Purpose: Decode keys on either side of the specified branch. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, October 14, 1997 @@ -824,9 +813,7 @@ H5B_decode_keys(H5F_t *f, H5B_t *bt, intn idx) * Purpose: Adds a new item to the B-tree. If the root node of * the B-tree splits then the B-tree gets a new address. * - * Return: Success: SUCCEED. - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -1006,9 +993,7 @@ H5B_insert(H5F_t *f, const H5B_class_t *type, const haddr_t *addr, * on whether ANCHOR is H5B_INS_LEFT or H5B_INS_RIGHT. The BT * argument is a pointer to a protected B-tree node. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -1490,9 +1475,7 @@ H5B_insert_helper(H5F_t *f, const haddr_t *addr, const H5B_class_t *type, * Purpose: Calls the list callback for each leaf node of the * B-tree, passing it the UDATA structure. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -1876,10 +1859,8 @@ H5B_remove_helper(H5F_t *f, const haddr_t *addr, const H5B_class_t *type, * * Note: The current version does not attempt to rebalance the tree. * - * Return: Success: SUCCEED - * - * Failure: FAIL. Failure includes not being able to - * find the object which is to be removed. + * Return: Non-negative on success/Negative on failure (Failure includes not + * being able to find the object which is to be removed.) * * Programmer: Robb Matzke * Wednesday, September 16, 1998 @@ -1997,9 +1978,7 @@ H5B_nodesize(H5F_t *f, const H5B_class_t *type, * * Purpose: Prints debugging info about a B-tree. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -106,7 +106,7 @@ USAGE herr_t H5D_init_interface() RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Initializes any interface-specific data or routines. @@ -120,7 +120,7 @@ H5D_init_interface(void) /* Initialize the atom group for the dataset IDs */ if ((ret_value = H5I_init_group(H5I_DATASET, H5I_DATASETID_HASHSIZE, H5D_RESERVED_ATOMS, - (herr_t (*)(void *)) H5D_close)) != FAIL) { + (herr_t (*)(void *)) H5D_close)) >=0) { ret_value = H5_add_exit(H5D_term_interface); } FUNC_LEAVE(ret_value); @@ -135,7 +135,7 @@ H5D_init_interface(void) USAGE void H5D_term_interface() RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Release the atom group and any other resources allocated. GLOBAL VARIABLES @@ -302,9 +302,7 @@ H5Dopen(hid_t loc_id, const char *name) * resources used by it. It is illegal to subsequently use that * same dataset ID in calls to other dataset functions. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Errors: * ARGS BADTYPE Not a dataset. @@ -572,9 +570,7 @@ H5Dget_create_plist(hid_t dset_id) * The PLIST_ID can be the constant H5P_DEFAULT in which * case the default data transfer properties are used. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Errors: * ARGS BADTYPE Not a data space. @@ -679,9 +675,7 @@ H5Dread(hid_t dset_id, hid_t mem_type_id, hid_t mem_space_id, * The PLIST_ID can be the constant H5P_DEFAULT in which * case the default data transfer properties are used. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Errors: * @@ -763,9 +757,7 @@ H5Dwrite(hid_t dset_id, hid_t mem_type_id, hid_t mem_space_id, * SIZE. The dimensionality of SIZE is the same as the data * space of the dataset being changed. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, January 30, 1998 @@ -1167,7 +1159,7 @@ done: * * Purpose: Opens a dataset for access. * - * Return: SUCCEED/FAIL + * Return: Dataset pointer on success, NULL on failure * * Errors: * @@ -1323,9 +1315,7 @@ done: * dataset object header, and frees all resources used by the * descriptor. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Errors: * DATASET CANTINIT Couldn't free the type or space, @@ -1383,9 +1373,7 @@ H5D_close(H5D_t *dataset) * Purpose: Reads (part of) a DATASET into application memory BUF. See * H5Dread() for complete details. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, December 4, 1997 @@ -1747,9 +1735,7 @@ H5D_read(H5D_t *dataset, const H5T_t *mem_type, const H5S_t *mem_space, * Purpose: Writes (part of) a DATASET to a file from application memory * BUF. See H5Dwrite() for complete details. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, December 4, 1997 @@ -2130,9 +2116,7 @@ H5D_write(H5D_t *dataset, const H5T_t *mem_type, const H5S_t *mem_space, * * Purpose: Increases the size of a dataset. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, January 30, 1998 @@ -2294,9 +2278,7 @@ H5D_get_file (const H5D_t *dset) * defined for SPACE then initialize only that part of the * dataset. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, October 5, 1998 diff --git a/src/H5Distore.c b/src/H5Distore.c index 4eeb05f..ccbc54f 100644 --- a/src/H5Distore.c +++ b/src/H5Distore.c @@ -218,9 +218,7 @@ H5F_istore_sizeof_rkey(H5F_t __unused__ *f, const void *_udata) * * Purpose: Decodes a raw key into a native key for the B-tree * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, October 10, 1997 @@ -261,9 +259,7 @@ H5F_istore_decode_key(H5F_t __unused__ *f, H5B_t *bt, uint8 *raw, void *_key) * * Purpose: Encode a key from native format to raw format. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, October 10, 1997 @@ -304,9 +300,7 @@ H5F_istore_encode_key(H5F_t __unused__ *f, H5B_t *bt, uint8 *raw, void *_key) * * Purpose: Prints a key. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, April 16, 1998 @@ -448,11 +442,9 @@ H5F_istore_cmp3(H5F_t __unused__ *f, void *_lt_key, void *_udata, * the domain represented by UDATA doesn't intersect the domain * already represented by the B-tree. * - * Return: Success: SUCCEED. The address of leaf is returned - * through the ADDR argument. It is also added - * to the UDATA. - * - * Failure: FAIL + * Return: Non-negative on success (The address of leaf is returned through + * the ADDR argument. It is also added to the UDATA.) + * /Negative on failure * * Programmer: Robb Matzke * Tuesday, October 14, 1997 @@ -540,10 +532,8 @@ H5F_istore_new_node(H5F_t *f, H5B_ins_t op, * called with the maximum stored chunk indices less than the * requested chunk indices. * - * Return: Success: SUCCEED with information about the chunk - * returned through the UDATA argument. - * - * Failure: FAIL if not found. + * Return: Non-negative on success (with information about the chunk returned + * through the UDATA argument.) /Negative on failure * * Programmer: Robb Matzke * Thursday, October 9, 1997 @@ -731,9 +721,7 @@ H5F_istore_insert(H5F_t *f, const haddr_t *addr, void *_lt_key, * Purpose: Initialize the raw data chunk cache for a file. This is * called when the file handle is initialized. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, May 18, 1998 @@ -772,9 +760,7 @@ H5F_istore_init (H5F_t *f) * the RESET flag is turned on because it results in one fewer * memory copy. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, May 21, 1998 @@ -896,9 +882,7 @@ H5F_istore_flush_entry (H5F_t *f, H5F_rdcc_ent_t *ent, hbool_t reset) * Purpose: Preempts the specified entry from the cache, flushing it to * disk if necessary. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, May 21, 1998 @@ -954,9 +938,7 @@ H5F_istore_preempt (H5F_t *f, H5F_rdcc_ent_t *ent) * Purpose: Writes all dirty chunks to disk and optionally preempts them * from the cache. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, May 21, 1998 @@ -1001,9 +983,7 @@ H5F_istore_flush (H5F_t *f, hbool_t preempt) * Purpose: Destroy the entire chunk cache by flushing dirty entries, * preempting all entries, and freeing the cache itself. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, May 21, 1998 @@ -1049,9 +1029,7 @@ H5F_istore_dest (H5F_t *f) * room for something which is SIZE bytes. Only unlocked * entries are considered for preemption. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, May 21, 1998 @@ -1440,9 +1418,7 @@ H5F_istore_lock (H5F_t *f, const H5O_layout_t *layout, * It's only purpose is to provide additional information to the * preemption policy. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, May 21, 1998 @@ -1524,9 +1500,7 @@ H5F_istore_unlock (H5F_t *f, const H5O_layout_t *layout, * Purpose: Reads a multi-dimensional buffer from (part of) an indexed raw * storage array. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, October 15, 1997 @@ -1696,9 +1670,7 @@ H5F_istore_read(H5F_t *f, const H5D_xfer_t *xfer, const H5O_layout_t *layout, * Purpose: Writes a multi-dimensional buffer to (part of) an indexed raw * storage array. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, October 15, 1997 @@ -1880,10 +1852,8 @@ H5F_istore_write(H5F_t *f, const H5D_xfer_t *xfer, const H5O_layout_t *layout, * This function must be called before passing ISTORE to any of * the other indexed storage functions! * - * Return: Success: SUCCEED with the ISTORE argument initialized - * and ready to write to an object header. - * - * Failure: FAIL + * Return: Non-negative on success (with the ISTORE argument initialized and + * ready to write to an object header.) /Negative on failure * * Programmer: Robb Matzke * Tuesday, October 21, 1997 @@ -1928,9 +1898,7 @@ H5F_istore_create(H5F_t *f, H5O_layout_t *layout /*out */ ) * HEADERS is non-zero then print table column headers, * otherwise assume that the H5AC layer has already printed them. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, May 21, 1998 @@ -1989,9 +1957,7 @@ H5F_istore_stats (H5F_t *f, hbool_t headers) * * Purpose: Debugs a B-tree node for indexed raw data storage. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, April 16, 1998 @@ -2024,9 +1990,7 @@ H5F_istore_debug(H5F_t *f, const haddr_t *addr, FILE * stream, intn indent, * assigned. Save the retrieved information in the udata * supplied. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Albert Cheng * June 27, 1998 @@ -2072,9 +2036,7 @@ H5F_istore_get_addr (H5F_t *f, const H5O_layout_t *layout, * Return SUCCEED if all needed allocation succeed, otherwise * FAIL. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Note: Current implementation relies on cache_size being 0, * thus no chunk is cashed and written to disk immediately @@ -148,9 +148,7 @@ void *H5E_auto_data_g = stderr; * * See Also: H5Ewalk() * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, February 27, 1998 @@ -179,9 +177,7 @@ H5Eset_auto(H5E_auto_t func, void *client_data) * traversal function and its data. Either (or both) arguments * may be null in which case the value is not returned. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Saturday, February 28, 1998 @@ -209,10 +205,7 @@ H5Eget_auto(H5E_auto_t *func, void **client_data) * * Purpose: Clears the error stack for the current thread. * - * Return: Success: SUCCEED - * - * Failure: FAIL. This function can fail if there are - * problems initializing the library. + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, February 27, 1998 @@ -239,9 +232,7 @@ H5Eclear(void) * prints error messages. Users are encouraged to write there * own more specific error handlers. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, February 27, 1998 @@ -276,10 +267,7 @@ H5Eprint(FILE *stream) * Purpose: Walks the error stack for the current thread and calls some * function for each error along the way. * - * Return: Success: SUCCEED - * - * Failure: FAIL. This function can fail if there are - * problems initializing the library. + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, February 27, 1998 @@ -325,9 +313,7 @@ H5Ewalk(H5E_direction_t direction, H5E_walk_t func, void *client_data) * CLIENT_DATA argument of H5Ewalk(). It is expected to be a * file pointer (or stderr if null). * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, December 12, 1997 @@ -458,9 +444,7 @@ H5Eget_minor (H5E_minor_t n) * the function name and file name automatically, but the * programmer is responsible for the description string). * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, December 12, 1997 @@ -514,10 +498,7 @@ H5E_push(H5E_major_t maj_num, H5E_minor_t min_num, const char *function_name, * * Purpose: Clears the error stack for the current thread. * - * Return: Success: SUCCEED - * - * Failure: FAIL. This function can fail if there are - * problems initializing the library. + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, February 27, 1998 @@ -554,10 +535,7 @@ H5E_clear(void) * direction), an error stack entry, and the CLIENT_DATA pointer * passed to H5E_print. * - * Return: Success: SUCCEED - * - * Failure: FAIL. This function can fail if there are - * problems initializing the library. + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, December 12, 1997 @@ -123,7 +123,7 @@ USAGE herr_t H5F_init_interface() RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Initializes any interface-specific data or routines. @@ -206,7 +206,7 @@ H5F_init_interface(void) USAGE void H5F_term_interface() RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Release the atom group and any other resources allocated. GLOBAL VARIABLES @@ -604,9 +604,7 @@ H5F_new(H5F_file_t *shared, const H5F_create_t *fcpl, const H5F_access_t *fapl) * for the file struct. The shared info for the file is freed * only when its reference count reaches zero. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -1331,9 +1329,7 @@ H5Fopen(const char *filename, unsigned flags, hid_t access_id) * not remove them from the cache. The OBJECT_ID can be a file, * dataset, group, attribute, or named data type. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, August 6, 1998 @@ -1436,9 +1432,7 @@ H5Fflush(hid_t object_id, H5F_scope_t scope) * CACHE CANTFLUSH Can't flush cache. * IO WRITEERROR Can't write header. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -1560,9 +1554,7 @@ H5F_flush(H5F_t *f, H5F_scope_t scope, hbool_t invalidate) * called when a file hid_t reference count gets to zero as a * result of calling H5Fclose(). * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, September 23, 1997 @@ -1693,7 +1685,7 @@ H5F_close(H5F_t *f) CACHE CANTFLUSH Can't flush cache. RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION This function terminates access to an HDF5 file. If this is the last @@ -1744,9 +1736,7 @@ H5Fclose(hid_t file_id) * using mount properties in PLIST. CHILD must not already be * mouted and must not be a mount ancestor of the mount-point. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, October 6, 1998 @@ -1862,9 +1852,7 @@ H5F_mount(H5G_entry_t *loc, const char *name, H5F_t *child, * group, the H5G_namei() will resolve it to the root of the * mounted file, not the group where the file is mounted. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, October 6, 1998 @@ -1973,9 +1961,7 @@ H5F_unmount(H5G_entry_t *loc, const char *name) * Purpose: If ENT is a mount point then copy the entry for the root * group of the mounted file into ENT. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, October 6, 1998 @@ -2035,9 +2021,7 @@ H5F_mountpoint(H5G_entry_t *find/*in,out*/) * Purpose: Mount file CHILD_ID onto the group specified by LOC_ID and * NAME using mount properties PLIST_ID. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, October 6, 1998 @@ -2097,9 +2081,7 @@ H5Fmount(hid_t loc_id, const char *name, hid_t child_id, hid_t plist_id) * it's the group in the parent, but if it was opened after the * mount then it's the root group of the child. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, October 6, 1998 @@ -2195,9 +2177,7 @@ H5Freopen(hid_t file_id) * Errors: * IO READERROR Low-level read failed. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -2242,9 +2222,7 @@ H5F_block_read(H5F_t *f, const haddr_t *addr, hsize_t size, * IO WRITEERROR Low-level write failed. * IO WRITEERROR No write intent. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -2292,9 +2270,7 @@ H5F_block_write(H5F_t *f, const haddr_t *addr, hsize_t size, * * Errors: * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov diff --git a/src/H5Farray.c b/src/H5Farray.c index 2a2cd1c..0c77bb5 100644 --- a/src/H5Farray.c +++ b/src/H5Farray.c @@ -31,9 +31,7 @@ static intn interface_initialize_g = FALSE; * * Purpose: Creates an array of bytes. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, January 16, 1998 @@ -99,9 +97,7 @@ H5F_arr_create (H5F_t *f, struct H5O_layout_t *layout/*in,out*/) * MEM_SIZE[]. The dimensionality of these vectors is implied by * the LAYOUT argument. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, January 16, 1998 @@ -323,9 +319,7 @@ H5F_arr_read (H5F_t *f, const H5D_xfer_t *xfer, * memory array is MEM_SIZE[]. The dimensionality of these * vectors is implied by the LAYOUT argument. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, January 16, 1998 diff --git a/src/H5Fcore.c b/src/H5Fcore.c index f87f436..49c41a9 100644 --- a/src/H5Fcore.c +++ b/src/H5Fcore.c @@ -60,9 +60,7 @@ const H5F_low_class_t H5F_LOW_CORE_g[1] = {{ * create a new file. Therefore, this function always returns * false and KEY is never initialized. * - * Return: Success: FALSE - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, October 24, 1997 @@ -142,9 +140,7 @@ H5F_core_open(const char __unused__ *name, * * Errors: * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, October 22, 1997 @@ -175,9 +171,7 @@ H5F_core_close(H5F_low_t *lf, const H5F_access_t __unused__ *access_parms) * * Errors: * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, October 22, 1997 @@ -225,9 +219,7 @@ H5F_core_read(H5F_low_t *lf, const H5F_access_t __unused__ *access_parms, * * Errors: * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, October 22, 1997 diff --git a/src/H5Ffamily.c b/src/H5Ffamily.c index 8d429fa..db8f0ea 100644 --- a/src/H5Ffamily.c +++ b/src/H5Ffamily.c @@ -260,9 +260,7 @@ H5F_fam_open(const char *name, const H5F_access_t *access_parms, * Purpose: Closes all members of a file family and releases resources * used by the file descriptor. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, November 10, 1997 @@ -302,9 +300,7 @@ H5F_fam_close(H5F_low_t *lf, const H5F_access_t *access_parms) * flushing the file causes the first member to be physically * extended to it's maximum size). * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, November 10, 1997 @@ -369,9 +365,7 @@ H5F_fam_read(H5F_low_t *lf, const H5F_access_t *access_parms, * of file, so this function will extend the physical file to * accommodate the new data if necessary. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, November 10, 1997 @@ -490,9 +484,7 @@ H5F_fam_write(H5F_low_t *lf, const H5F_access_t *access_parms, * the member size if we open this file for read access at a * later date. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, November 10, 1997 diff --git a/src/H5Fistore.c b/src/H5Fistore.c index 4eeb05f..ccbc54f 100644 --- a/src/H5Fistore.c +++ b/src/H5Fistore.c @@ -218,9 +218,7 @@ H5F_istore_sizeof_rkey(H5F_t __unused__ *f, const void *_udata) * * Purpose: Decodes a raw key into a native key for the B-tree * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, October 10, 1997 @@ -261,9 +259,7 @@ H5F_istore_decode_key(H5F_t __unused__ *f, H5B_t *bt, uint8 *raw, void *_key) * * Purpose: Encode a key from native format to raw format. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, October 10, 1997 @@ -304,9 +300,7 @@ H5F_istore_encode_key(H5F_t __unused__ *f, H5B_t *bt, uint8 *raw, void *_key) * * Purpose: Prints a key. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, April 16, 1998 @@ -448,11 +442,9 @@ H5F_istore_cmp3(H5F_t __unused__ *f, void *_lt_key, void *_udata, * the domain represented by UDATA doesn't intersect the domain * already represented by the B-tree. * - * Return: Success: SUCCEED. The address of leaf is returned - * through the ADDR argument. It is also added - * to the UDATA. - * - * Failure: FAIL + * Return: Non-negative on success (The address of leaf is returned through + * the ADDR argument. It is also added to the UDATA.) + * /Negative on failure * * Programmer: Robb Matzke * Tuesday, October 14, 1997 @@ -540,10 +532,8 @@ H5F_istore_new_node(H5F_t *f, H5B_ins_t op, * called with the maximum stored chunk indices less than the * requested chunk indices. * - * Return: Success: SUCCEED with information about the chunk - * returned through the UDATA argument. - * - * Failure: FAIL if not found. + * Return: Non-negative on success (with information about the chunk returned + * through the UDATA argument.) /Negative on failure * * Programmer: Robb Matzke * Thursday, October 9, 1997 @@ -731,9 +721,7 @@ H5F_istore_insert(H5F_t *f, const haddr_t *addr, void *_lt_key, * Purpose: Initialize the raw data chunk cache for a file. This is * called when the file handle is initialized. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, May 18, 1998 @@ -772,9 +760,7 @@ H5F_istore_init (H5F_t *f) * the RESET flag is turned on because it results in one fewer * memory copy. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, May 21, 1998 @@ -896,9 +882,7 @@ H5F_istore_flush_entry (H5F_t *f, H5F_rdcc_ent_t *ent, hbool_t reset) * Purpose: Preempts the specified entry from the cache, flushing it to * disk if necessary. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, May 21, 1998 @@ -954,9 +938,7 @@ H5F_istore_preempt (H5F_t *f, H5F_rdcc_ent_t *ent) * Purpose: Writes all dirty chunks to disk and optionally preempts them * from the cache. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, May 21, 1998 @@ -1001,9 +983,7 @@ H5F_istore_flush (H5F_t *f, hbool_t preempt) * Purpose: Destroy the entire chunk cache by flushing dirty entries, * preempting all entries, and freeing the cache itself. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, May 21, 1998 @@ -1049,9 +1029,7 @@ H5F_istore_dest (H5F_t *f) * room for something which is SIZE bytes. Only unlocked * entries are considered for preemption. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, May 21, 1998 @@ -1440,9 +1418,7 @@ H5F_istore_lock (H5F_t *f, const H5O_layout_t *layout, * It's only purpose is to provide additional information to the * preemption policy. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, May 21, 1998 @@ -1524,9 +1500,7 @@ H5F_istore_unlock (H5F_t *f, const H5O_layout_t *layout, * Purpose: Reads a multi-dimensional buffer from (part of) an indexed raw * storage array. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, October 15, 1997 @@ -1696,9 +1670,7 @@ H5F_istore_read(H5F_t *f, const H5D_xfer_t *xfer, const H5O_layout_t *layout, * Purpose: Writes a multi-dimensional buffer to (part of) an indexed raw * storage array. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, October 15, 1997 @@ -1880,10 +1852,8 @@ H5F_istore_write(H5F_t *f, const H5D_xfer_t *xfer, const H5O_layout_t *layout, * This function must be called before passing ISTORE to any of * the other indexed storage functions! * - * Return: Success: SUCCEED with the ISTORE argument initialized - * and ready to write to an object header. - * - * Failure: FAIL + * Return: Non-negative on success (with the ISTORE argument initialized and + * ready to write to an object header.) /Negative on failure * * Programmer: Robb Matzke * Tuesday, October 21, 1997 @@ -1928,9 +1898,7 @@ H5F_istore_create(H5F_t *f, H5O_layout_t *layout /*out */ ) * HEADERS is non-zero then print table column headers, * otherwise assume that the H5AC layer has already printed them. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, May 21, 1998 @@ -1989,9 +1957,7 @@ H5F_istore_stats (H5F_t *f, hbool_t headers) * * Purpose: Debugs a B-tree node for indexed raw data storage. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, April 16, 1998 @@ -2024,9 +1990,7 @@ H5F_istore_debug(H5F_t *f, const haddr_t *addr, FILE * stream, intn indent, * assigned. Save the retrieved information in the udata * supplied. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Albert Cheng * June 27, 1998 @@ -2072,9 +2036,7 @@ H5F_istore_get_addr (H5F_t *f, const H5O_layout_t *layout, * Return SUCCEED if all needed allocation succeed, otherwise * FAIL. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Note: Current implementation relies on cache_size being 0, * thus no chunk is cashed and written to disk immediately diff --git a/src/H5Flow.c b/src/H5Flow.c index 31ba501..59a2425 100644 --- a/src/H5Flow.c +++ b/src/H5Flow.c @@ -206,9 +206,7 @@ H5F_low_close(H5F_low_t *lf, const H5F_access_t *access_parms) * IO READERROR Read failed. * IO UNSUPPORTED No read method. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, October 22, 1997 @@ -258,9 +256,7 @@ H5F_low_read(H5F_low_t *lf, const H5F_access_t *access_parms, * IO UNSUPPORTED No write method. * IO WRITEERROR Write failed. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, October 22, 1997 @@ -352,9 +348,7 @@ H5F_low_write(H5F_low_t *lf, const H5F_access_t *access_parms, * file. Extending the physical file is necessary because * H5F_open() checks for truncated files. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, November 10, 1997 @@ -516,12 +510,9 @@ H5F_low_access(const H5F_low_class_t *type, const char *name, * end of file marker. A subclass can override this function by * providing its own allocation method. * - * Return: Success: SUCCEED, the address of the old end-of-file - * is returned through the ADDR argument and the - * logical size of the file has been extended by - * SIZE bytes. - * - * Failure: FAIL + * Return: Non-negative on success (the address of the old end-of-file is + * returned through the ADDR argument and the logical size of the + * file has been extended by SIZE bytes.) /Negative on failure * * Programmer: Robb Matzke * Thursday, November 13, 1997 @@ -570,8 +561,7 @@ H5F_low_extend(H5F_low_t *lf, const H5F_access_t *access_parms, intn op, * ADDR will be the address within the free * block where the request can be satisfied. * - * Failure: FAIL with the output value of ADDR - * undefined. + * Failure: Negative with the output value of ADDR undefined. * * Programmer: Robb Matzke * Tuesday, June 9, 1998 @@ -624,9 +614,7 @@ H5F_low_alloc (H5F_low_t *lf, intn op, hsize_t alignment, hsize_t threshold, * * Purpose: Sets the logical end-of-file to the specified address. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, November 13, 1997 diff --git a/src/H5Fmpio.c b/src/H5Fmpio.c index aacc59d..b47188c 100644 --- a/src/H5Fmpio.c +++ b/src/H5Fmpio.c @@ -405,9 +405,7 @@ H5F_mpio_open(const char *name, const H5F_access_t *access_parms, uintn flags, * Errors: * IO CLOSEERROR Fclose failed. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: * January 30, 1998 @@ -467,8 +465,7 @@ H5F_mpio_close(H5F_low_t *lf, const H5F_access_t __unused__ *access_parms) * IO READERROR MPI_File_read_at failed. * IO READERROR MPI_Get_count failed * - * Return: Success: SUCCEED - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * (use_types and old_use_types in the access params are altered) * * Programmer: rky 980130 @@ -708,8 +705,7 @@ H5F_mpio_tas_allsame(H5F_low_t *lf, hbool_t newval ) * Errors: * IO WRITEERROR MPI_File_write_at failed. * - * Return: Success: SUCCEED - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * (use_types and old_use_types in the access params are altered) * * Programmer: @@ -901,9 +897,7 @@ H5F_mpio_write(H5F_low_t *lf, H5F_access_t *access_parms, * Errors: * IO WRITEERROR MPI_File_sync failed. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: * January 30, 1998 @@ -947,10 +941,8 @@ H5F_mpio_flush(H5F_low_t *lf, const H5F_access_t __unused__ *access_parms) * * Problems and limitations: * - * Return: Success: return value is SUCCEED - * and the haddr_t contains the converted value - * - * Failure: return value is FAIL, the haddr_t is undefined + * Return: Non-negative on success (the haddr_t contains the converted + * value) /Negative on failure (the haddr_t is undefined) * * Programmer: * January 30, 1998 @@ -978,12 +970,8 @@ H5F_MPIOff_to_haddr( MPI_Offset mpi_off, haddr_t *addr ) * * Problems and limitations: * - * Return: Success: return value is SUCCEED - * and the MPIOffset contains the converted - * value. - * - * Failure: return value is FAIL, the MPIOffset is - * undefined. + * Return: Non-negative on success (the MPIOffset contains the converted + * value.) /Negative on failure (the MPIOffset is undefined.) * * Programmer: * January 30, 1998 diff --git a/src/H5Fsec2.c b/src/H5Fsec2.c index 96f6d0f..874172b 100644 --- a/src/H5Fsec2.c +++ b/src/H5Fsec2.c @@ -115,9 +115,7 @@ H5F_sec2_open(const char *name, const H5F_access_t __unused__ *access_parms, * Errors: * IO CLOSEERROR Close failed. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, October 22, 1997 @@ -150,9 +148,7 @@ H5F_sec2_close(H5F_low_t *lf, const H5F_access_t __unused__ *access_parms) * IO READERROR Read failed. * IO SEEKERROR Lseek failed. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, October 22, 1997 @@ -257,9 +253,7 @@ H5F_sec2_read(H5F_low_t *lf, const H5F_access_t __unused__ *access_parms, * IO SEEKERROR Lseek failed. * IO WRITEERROR Write failed. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, October 22, 1997 diff --git a/src/H5Fsplit.c b/src/H5Fsplit.c index 25ef2d5..b3fcc10 100644 --- a/src/H5Fsplit.c +++ b/src/H5Fsplit.c @@ -168,9 +168,7 @@ H5F_split_open(const char *name, const H5F_access_t *access_parms, * * Purpose: Closes a split file. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, November 13, 1997 @@ -201,9 +199,7 @@ H5F_split_close(H5F_low_t *lf, const H5F_access_t *access_parms) * data/raw data boundary. Reading past the end of a file * returns zeros instead of failing. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, November 13, 1997 @@ -253,9 +249,7 @@ H5F_split_read(H5F_low_t *lf, const H5F_access_t *access_parms, * * Purpose: Writes BUF to either the meta data file or the raw data file. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, November 13, 1997 @@ -304,9 +298,7 @@ H5F_split_write(H5F_low_t *lf, const H5F_access_t *access_parms, * * Purpose: Flushes all data to disk. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, November 13, 1997 @@ -413,10 +405,9 @@ H5F_split_access(const char *name, const H5F_access_t *access_parms, * Purpose: Allocates memory from the end of the meta data file or raw * data file. * - * Return: Success: SUCCEED with the address of the allocated - * memory returned through the ADDR argument. - * - * Failure: FAIL + * Return: Non-negative on success (with the address of the allocated + * memory returned through the ADDR argument.) /Negative + * on failure * * Programmer: Robb Matzke * Thursday, November 13, 1997 @@ -476,7 +467,7 @@ H5F_split_extend(H5F_low_t *lf, const H5F_access_t *access_parms, intn op, * contain the address within the free block * where the request starts. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Tuesday, June 9, 1998 diff --git a/src/H5Fstdio.c b/src/H5Fstdio.c index 5fa8078..5863dd6 100644 --- a/src/H5Fstdio.c +++ b/src/H5Fstdio.c @@ -140,9 +140,7 @@ H5F_stdio_open(const char *name, const H5F_access_t __unused__ *access_parms, * Errors: * IO CLOSEERROR Fclose failed. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, October 22, 1997 @@ -175,9 +173,7 @@ H5F_stdio_close(H5F_low_t *lf, const H5F_access_t __unused__ *access_parms) * IO READERROR Fread failed. * IO SEEKERROR Fseek failed. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, October 22, 1997 @@ -286,9 +282,7 @@ H5F_stdio_read(H5F_low_t *lf, const H5F_access_t __unused__ *access_parms, * IO SEEKERROR Fseek failed. * IO WRITEERROR Fwrite failed. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, October 22, 1997 @@ -375,9 +369,7 @@ H5F_stdio_write(H5F_low_t *lf, const H5F_access_t __unused__ *access_parms, * Errors: * IO WRITEERROR Fflush failed. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, October 22, 1997 @@ -214,9 +214,7 @@ H5Gopen(hid_t loc_id, const char *name) * Purpose: Closes the specified group. The group ID will no longer be * valid for accessing the group. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, December 31, 1997 @@ -263,8 +261,8 @@ H5Gclose(hid_t group_id) * returns non-zero, or zero if all members were * processed with no operator returning non-zero. * - * Failure: FAIL if something goes wrong within the - * library, or a negative value returned by one + * Failure: Negative if something goes wrong within the + * library, or the negative value returned by one * of the operators. * * Programmer: Robb Matzke @@ -335,9 +333,7 @@ H5Giterate(hid_t loc_id, const char *name, int *idx, * inserted as an atomic operation. Both names are interpreted * relative to LOC_ID which is either a file ID or a group ID. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, April 6, 1998 @@ -392,9 +388,7 @@ H5Gmove(hid_t loc_id, const char *src, const char *dst) * is made for `./x/y/bar' then the actual object looked up is * `./x/y/./foo'. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, April 6, 1998 @@ -445,9 +439,7 @@ H5Glink(hid_t loc_id, H5G_link_t type, const char *cur_name, * object is open, then the reclamation of the file space is * delayed until all handles to the object are closed). * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, April 6, 1998 @@ -488,10 +480,8 @@ H5Gunlink(hid_t loc_id, const char *name) * non-zero then all symbolic links are followed; otherwise all * links except the last component of the name are followed. * - * Return: Success: SUCCEED with the fields of STATBUF (if - * non-null) initialized. - * - * Failure: FAIL + * Return: Non-negative on success (with the fields of STATBUF (if + * non-null) initialized.) /Negative on failure * * Programmer: Robb Matzke * Monday, April 13, 1998 @@ -533,9 +523,8 @@ H5Gget_objinfo(hid_t loc_id, const char *name, hbool_t follow_link, * most SIZE characters (counting the null terminator) are * copied to the BUF result buffer. * - * Return: Success: SUCCEED, the link value is in BUF. - * - * Failure: FAIL + * Return: Non-negative on success (the link value is in BUF.) /Negative on + * failure * * Programmer: Robb Matzke * Monday, April 13, 1998 @@ -578,9 +567,7 @@ H5Gget_linkval(hid_t loc_id, const char *name, size_t size, char *buf/*out*/) * one comment at a time. Passing NULL for the COMMENT argument * will remove the comment property from the object. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, July 20, 1998 @@ -627,7 +614,7 @@ H5Gset_comment(hid_t loc_id, const char *name, const char *comment) * the null terminator. The value returned may * be larger than the BUFSIZE argument. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Monday, July 20, 1998 @@ -676,9 +663,7 @@ H5Gget_comment(hid_t loc_id, const char *name, size_t bufsize, char *buf) * * Purpose: Initializes the H5G interface. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, January 5, 1998 @@ -857,12 +842,12 @@ H5G_basename(const char *name, size_t *size_p) * * Errors: * - * Return: Success: SUCCEED if name can be fully resolved. See + * Return: Success: Non-negative if name can be fully resolved. See * above for values of REST, GRP_ENT, and * OBJ_ENT. NLINKS has been decremented for * each symbolic link that was followed. * - * Failure: FAIL if the name could not be fully resolved. + * Failure: Negative if the name could not be fully resolved. * See above for values of REST, GRP_ENT, and * OBJ_ENT. * @@ -991,12 +976,12 @@ H5G_namei(H5G_entry_t *loc_ent, const char *name, const char **rest/*out*/, * Purpose: Traverses symbolic link. The link head appears in the group * whose entry is GRP_ENT and the link head entry is OBJ_ENT. * - * Return: Success: SUCCEED, OBJ_ENT will contain information + * Return: Success: Non-negative, OBJ_ENT will contain information * about the object to which the link points and * GRP_ENT will contain the information about * the group in which the link tail appears. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Friday, April 10, 1998 @@ -1053,9 +1038,7 @@ H5G_traverse_slink (H5G_entry_t *grp_ent/*in,out*/, * group. Otherwise a new root group is created and then * opened. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -1300,9 +1283,7 @@ H5G_reopen(H5G_t *grp) * * Purpose: Closes the specified group. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, January 5, 1998 @@ -1371,9 +1352,7 @@ H5G_rootof(H5F_t *f) * * Errors: * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, September 19, 1997 @@ -1452,10 +1431,10 @@ H5G_insert(H5G_entry_t *loc, const char *name, H5G_entry_t *ent) * * Errors: * - * Return: Success: SUCCEED, see above for values of GRP_ENT and + * Return: Success: Non-negative, see above for values of GRP_ENT and * OBJ_ENT. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * matzke@llnl.gov @@ -1661,9 +1640,7 @@ H5G_loc (hid_t loc_id) * Purpose: Creates a link from NEW_NAME to CUR_NAME. See H5Glink() for * full documentation. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, April 6, 1998 @@ -1788,10 +1765,10 @@ H5G_link (H5G_entry_t *loc, H5G_link_t type, const char *cur_name, * * Purpose: Returns information about an object. * - * Return: Success: SUCCEED with info about the object returned + * Return: Success: Non-negative with info about the object returned * through STATBUF if it isn't the null pointer. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Monday, April 13, 1998 @@ -1887,13 +1864,13 @@ H5G_get_objinfo (H5G_entry_t *loc, const char *name, hbool_t follow_link, * * Purpose: Returns the value of a symbolic link. * - * Return: Success: SUCCEED, with at most SIZE bytes of the link + * Return: Success: Non-negative, with at most SIZE bytes of the link * value copied into the BUF buffer. If the * link value is larger than SIZE characters * counting the null terminator then the BUF * result will not be null terminated. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Monday, April 13, 1998 @@ -1953,9 +1930,7 @@ H5G_linkval (H5G_entry_t *loc, const char *name, size_t size, char *buf/*out*/) * * Purpose: (Re)sets the comment for an object. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, July 20, 1998 @@ -2004,7 +1979,7 @@ H5G_set_comment(H5G_entry_t *loc, const char *name, const char *buf) * null terminator. Zero if the object has no * comment. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Monday, July 20, 1998 @@ -2048,9 +2023,7 @@ H5G_get_comment(H5G_entry_t *loc, const char *name, size_t bufsize, char *buf) * * Purpose: Unlink a name from a group. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, September 17, 1998 @@ -2099,9 +2072,7 @@ H5G_unlink(H5G_entry_t *loc, const char *name) * * Purpose: Atomically rename an object. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, September 25, 1998 diff --git a/src/H5Gent.c b/src/H5Gent.c index 1c0e981..bc93735 100644 --- a/src/H5Gent.c +++ b/src/H5Gent.c @@ -59,9 +59,7 @@ H5G_ent_cache(H5G_entry_t *ent, H5G_type_t *cache_type) * H5G_NO_CHANGE then the cache type isn't changed--just the * dirty bit is set. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, September 19, 1997 @@ -89,10 +87,10 @@ H5G_ent_modified(H5G_entry_t *ent, H5G_type_t cache_type) * Errors: * SYM CANTDECODE Can't decode. * - * Return: Success: SUCCEED, with *pp pointing to the first byte + * Return: Success: Non-negative, with *pp pointing to the first byte * after the last symbol. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * matzke@llnl.gov @@ -132,10 +130,10 @@ H5G_ent_decode_vec(H5F_t *f, const uint8 **pp, H5G_entry_t *ent, intn n) * * Errors: * - * Return: Success: SUCCEED with *pp pointing to the first byte + * Return: Success: Non-negative with *pp pointing to the first byte * following the symbol table entry. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * matzke@llnl.gov @@ -201,10 +199,10 @@ H5G_ent_decode(H5F_t *f, const uint8 **pp, H5G_entry_t *ent) * Errors: * SYM CANTENCODE Can't encode. * - * Return: Success: SUCCEED, with *pp pointing to the first byte + * Return: Success: Non-negative, with *pp pointing to the first byte * after the last symbol. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * matzke@llnl.gov @@ -245,10 +243,10 @@ H5G_ent_encode_vec(H5F_t *f, uint8 **pp, const H5G_entry_t *ent, intn n) * * Errors: * - * Return: Success: SUCCEED, with *pp pointing to the first byte + * Return: Success: Non-negative, with *pp pointing to the first byte * after the symbol table entry. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * matzke@llnl.gov @@ -322,9 +320,7 @@ H5G_ent_encode(H5F_t *f, uint8 **pp, const H5G_entry_t *ent) * * Errors: * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov diff --git a/src/H5Gnode.c b/src/H5Gnode.c index e9b4ac7..57ad6bd 100644 --- a/src/H5Gnode.c +++ b/src/H5Gnode.c @@ -125,9 +125,7 @@ H5G_node_sizeof_rkey(H5F_t *f, const void __unused__ *udata) * * Purpose: Decodes a raw key into a native key. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -159,9 +157,7 @@ H5G_node_decode_key(H5F_t *f, H5B_t __unused__ *bt, uint8 *raw, void *_key) * * Purpose: Encodes a native key into a raw key. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -221,10 +217,10 @@ H5G_node_size(H5F_t *f) * is also called internally to split a symbol node with LT_KEY * and RT_KEY null pointers. * - * Return: Success: SUCCEED. The address of symbol table node is + * Return: Success: Non-negative. The address of symbol table node is * returned through the ADDR argument. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * matzke@llnl.gov @@ -292,9 +288,7 @@ H5G_node_create(H5F_t *f, H5B_ins_t __unused__ op, void *_lt_key, * * Purpose: Flush a symbol table node to disk. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -595,10 +589,10 @@ H5G_node_cmp3(H5F_t *f, void *_lt_key, void *_udata, void *_rt_key) * entry field. Otherwise the entry is copied from the * UDATA entry field to the symbol table. * - * Return: Success: SUCCEED if found and data returned through + * Return: Success: Non-negative if found and data returned through * the UDATA pointer. * - * Failure: FAIL if not found. + * Failure: Negative if not found. * * Programmer: Robb Matzke * matzke@llnl.gov @@ -1029,9 +1023,7 @@ H5G_node_remove(H5F_t *f, const haddr_t *addr, void *_lt_key/*in,out*/, * * Purpose: This function gets called during a group iterate operation. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -1118,9 +1110,7 @@ H5G_node_iterate (H5F_t *f, const haddr_t *addr, void *_udata) * Purpose: Prints debugging information about a symbol table node * or a B-tree node for a symbol table B-tree. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov diff --git a/src/H5Gstab.c b/src/H5Gstab.c index 2e36135..200c2e8 100644 --- a/src/H5Gstab.c +++ b/src/H5Gstab.c @@ -34,9 +34,7 @@ static hbool_t interface_initialize_g = FALSE; * * Errors: * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -115,9 +113,7 @@ H5G_stab_create(H5F_t *f, size_t init, H5G_entry_t *self/*out*/) * * Errors: * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -166,9 +162,7 @@ H5G_stab_find(H5G_entry_t *grp_ent, const char *name, * * Errors: * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -222,9 +216,7 @@ H5G_stab_insert(H5G_entry_t *grp_ent, const char *name, H5G_entry_t *obj_ent) * * Purpose: Remove NAME from a symbol table. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, September 17, 1998 @@ -349,9 +349,7 @@ H5HG_load (H5F_t *f, const haddr_t *addr, const void __unused__ *udata1, * Purpose: Flushes a global heap collection from memory to disk if it's * dirty. Optionally deletes teh heap from memory. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, March 27, 1998 @@ -411,7 +409,7 @@ H5HG_flush (H5F_t *f, hbool_t destroy, const haddr_t *addr, H5HG_heap_t *heap) * * Return: Success: The heap object ID of the new object. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Friday, March 27, 1998 @@ -505,10 +503,10 @@ H5HG_alloc (H5F_t *f, H5HG_heap_t *heap, int cwfsno, size_t size) * It is legal to push a zero-byte object onto the heap to get * the reference count features of heap objects. * - * Return: Success: SUCCEED, and a heap object handle returned + * Return: Success: Non-negative, and a heap object handle returned * through the HOBJ pointer. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Friday, March 27, 1998 @@ -726,7 +724,7 @@ H5HG_read (H5F_t *f, H5HG_t *hobj, void *object/*out*/) * * Return: Success: Number of links present after the adjustment. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Monday, March 30, 1998 @@ -776,9 +774,7 @@ H5HG_link (H5F_t *f, H5HG_t *hobj, intn adjust) * * Purpose: Removes the specified object from the global heap. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, March 30, 1998 @@ -878,9 +874,7 @@ H5HG_remove (H5F_t *f, H5HG_t *hobj) * * Purpose: Prints debugging information about a global heap collection. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -75,10 +75,10 @@ static intn interface_initialize_g = FALSE; * If the heap ever has to grow, then REALLOC_HINT is the * minimum amount by which the heap will grow. * - * Return: Success: SUCCEED. The file address of new heap is + * Return: Success: Non-negative. The file address of new heap is * returned through the ADDR argument. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * matzke@llnl.gov @@ -297,9 +297,7 @@ H5HL_load(H5F_t *f, const haddr_t *addr, const void __unused__ *udata1, * Purpose: Flushes a heap from memory to disk if it's dirty. Optionally * deletes the heap from memory. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -727,9 +725,7 @@ H5HL_insert(H5F_t *f, const haddr_t *addr, size_t buf_size, const void *buf) * Do not partially write an object to create it; the first * write for an object must be for the entire object. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -786,9 +782,7 @@ H5HL_write(H5F_t *f, const haddr_t *addr, size_t offset, size_t size, * in two separate objects, one at the original offset and * one at the first offset past the removed portion. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -908,9 +902,7 @@ H5HL_remove(H5F_t *f, const haddr_t *addr, size_t offset, size_t size) * * Purpose: Prints debugging information about a heap. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -145,7 +145,7 @@ NAME USAGE herr_t H5I_init_interface() RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Initializes any interface-specific data or routines. --------------------------------------------------------------------------*/ @@ -182,7 +182,7 @@ H5I_init_interface(void) later. RETURNS - Returns SUCCEED if successful and FAIL otherwise + Non-negative on success/Negative on failure ******************************************************************************/ intn @@ -274,9 +274,7 @@ H5I_init_group(H5I_type_t grp, /* IN: Group to initialize */ * the free-func for each ID's object and then adding the ID * struct to the ID free list. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Unknown * @@ -363,7 +361,7 @@ H5I_destroy_group(H5I_type_t grp) * * Return: Success: New object id. * - * Failure: FAIL + * Failure: Negative * * Programmer: Unknown * @@ -475,7 +473,7 @@ H5I_register(H5I_type_t grp, void *object) fail if the group is not a reference counted group. RETURNS - ID/FAIL + ID/Negative *******************************************************************************/ hid_t @@ -700,7 +698,7 @@ H5I_remove(hid_t id) * * Return: Success: New reference count. * - * Failure: FAIL + * Failure: Negative * * Programmer: Unknown * @@ -889,7 +887,7 @@ H5I_get_id_node(void) Puts an ID node into the free list RETURNS - SUCCEED + Non-negative on success/Negative on failure *******************************************************************************/ static herr_t @@ -912,7 +910,7 @@ H5I_release_id_node(H5I_id_info_t *id) USAGE intn H5I_term_interface() RETURNS - Returns SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Free various buffers allocated in the H5I routines. GLOBAL VARIABLES @@ -41,10 +41,10 @@ static intn interface_initialize_g = FALSE; * H5MF_RAW depending on the purpose for which the storage is * being requested. * - * Return: Success: SUCCEED. The file address of new chunk is + * Return: Success: Non-negative. The file address of new chunk is * returned through the ADDR argument. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * matzke@llnl.gov @@ -186,9 +186,7 @@ H5MF_alloc(H5F_t *f, intn op, hsize_t size, haddr_t *addr/*out*/) * * Note: This version of the function doesn't do anything. * - * Return: Success: 0 - * - * Failure: -1 + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -260,9 +258,7 @@ H5MF_xfree(H5F_t *f, const haddr_t *addr, hsize_t size) * new address will be returned. However, under certain * circumstances the library may return the same address. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, April 16, 1998 @@ -85,9 +85,7 @@ static void *(*H5O_fast_g[H5G_NCACHED]) (const H5G_cache_t *, * * Purpose: Initialize the H5O interface. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, January 6, 1998 @@ -118,11 +116,11 @@ H5O_init_interface(void) * write access and should eventually be closed by calling * H5O_close(). * - * Return: Success: SUCCEED, the ENT argument contains + * Return: Success: Non-negative, the ENT argument contains * information about the object header, * including its address. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * matzke@llnl.gov @@ -217,9 +215,7 @@ H5O_create(H5F_t *f, size_t size_hint, H5G_entry_t *ent/*out*/) * Purpose: Opens an object header which is described by the symbol table * entry OBJ_ENT. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, January 5, 1998 @@ -254,9 +250,7 @@ H5O_open(H5G_entry_t *obj_ent) * * Purpose: Closes an object header that was previously open. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, January 5, 1998 @@ -493,9 +487,7 @@ H5O_load(H5F_t *f, const haddr_t *addr, const void __unused__ *_udata1, * * Purpose: Flushes (and destroys) an object header. * - * Return: Success: SUCCESS - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -670,9 +662,7 @@ H5O_flush(H5F_t *f, hbool_t destroy, const haddr_t *addr, H5O_t *oh) * need to be freed. This function does that if appropriate * but doesn't free NATIVE. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -779,7 +769,7 @@ H5O_copy (const H5O_class_t *type, const void *mesg, void *dst) * * Return: Success: New link count * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * matzke@llnl.gov @@ -849,7 +839,7 @@ H5O_link(H5G_entry_t *ent, intn adjust) * * Return: Success: Number of messages of specified type. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Tuesday, April 21, 1998 @@ -1019,7 +1009,7 @@ H5O_read(H5G_entry_t *ent, const H5O_class_t *type, intn sequence, void *mesg) * * Return: Success: Index number of message. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * matzke@llnl.gov @@ -1109,7 +1099,7 @@ H5O_find_in_ohdr(H5F_t *f, const haddr_t *addr, const H5O_class_t **type_p, * Return: Success: The sequence number of the message that * was modified or created. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * matzke@llnl.gov @@ -1282,9 +1272,7 @@ H5O_modify(H5G_entry_t *ent, const H5O_class_t *type, intn overwrite, * unless one already exists. Then update any existing * modification time message with the current time. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, July 27, 1998 @@ -1344,9 +1332,7 @@ H5O_touch_oh(H5F_t *f, H5O_t *oh, hbool_t force) * is non-zero, nothing happens if there is no MTIME message in * the object header. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, July 27, 1998 @@ -1407,9 +1393,7 @@ H5O_touch(H5G_entry_t *ent, hbool_t force) * No attempt is made to join adjacent free areas of the * object header into a single larger free area. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -1525,7 +1509,7 @@ H5O_remove(H5G_entry_t *ent, const H5O_class_t *type, intn sequence) * Return: Success: Message index for null message which * is large enough to hold SIZE bytes. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * matzke@llnl.gov @@ -1652,7 +1636,7 @@ H5O_alloc_extend_chunk(H5O_t *oh, intn chunkno, size_t size) * least SIZE bytes not counting the message * ID or size fields. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * matzke@llnl.gov @@ -1838,7 +1822,7 @@ H5O_alloc_new_chunk(H5F_t *f, H5O_t *oh, size_t size) * * Return: Success: Index of message * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * matzke@llnl.gov @@ -1950,10 +1934,10 @@ H5O_alloc(H5F_t *f, H5O_t *oh, const H5O_class_t *type, size_t size) * * Purpose: Writes a message to the global heap. * - * Return: Success: SUCCEED, and HOBJ describes the global heap + * Return: Success: Non-negative, and HOBJ describes the global heap * object. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Thursday, April 2, 1998 @@ -2006,9 +1990,7 @@ H5O_share (H5F_t *f, const H5O_class_t *type, const void *mesg, * * Purpose: Prints debugging info about an object header. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov diff --git a/src/H5Oattr.c b/src/H5Oattr.c index 8665e11..32e9252 100644 --- a/src/H5Oattr.c +++ b/src/H5Oattr.c @@ -182,7 +182,7 @@ H5O_attr_decode(H5F_t *f, const uint8 *p, H5O_shared_t __unused__ *sh) const uint8 *p; IN: the raw information buffer const void *mesg; IN: Pointer to the simple datatype struct RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION This function encodes the native memory form of the attribute message in the "raw" disk form. @@ -344,9 +344,7 @@ H5O_attr_size(H5F_t __unused__ *f, const void *mesg) * Purpose: Frees resources within a attribute message, but doesn't free * the message itself. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, December 9, 1997 @@ -388,7 +386,7 @@ H5O_attr_reset(void *_mesg) intn indent; IN: Amount to indent information by intn fwidth; IN: Field width (?) RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION This function prints debugging output to the stream passed as a parameter. diff --git a/src/H5Ocomp.c b/src/H5Ocomp.c index 3f6ff54..a7e1969 100644 --- a/src/H5Ocomp.c +++ b/src/H5Ocomp.c @@ -155,9 +155,7 @@ H5O_pline_decode(H5F_t __unused__ *f, const uint8 *p, * * Purpose: Encodes message MESG into buffer P. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, April 15, 1998 @@ -362,9 +360,7 @@ H5O_pline_size (H5F_t __unused__ *f, const void *mesg) * Purpose: Resets a filter pipeline message by clearing all filters. * The MESG buffer is not freed. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, April 15, 1998 @@ -400,9 +396,7 @@ H5O_pline_reset (void *mesg) * on output stream STREAM. Each line is indented INDENT * characters and the field name takes up FWIDTH characters. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, April 15, 1998 diff --git a/src/H5Ocont.c b/src/H5Ocont.c index ab913e2..d864322 100644 --- a/src/H5Ocont.c +++ b/src/H5Ocont.c @@ -94,9 +94,7 @@ H5O_cont_decode(H5F_t *f, const uint8 *p, H5O_shared_t __unused__ *sh) * * Purpose: Encodes a continuation message. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -130,9 +128,7 @@ H5O_cont_encode(H5F_t *f, uint8 *p, const void *_mesg) * * Purpose: Prints debugging info. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov diff --git a/src/H5Odtype.c b/src/H5Odtype.c index 26bb58d..e68d352 100644 --- a/src/H5Odtype.c +++ b/src/H5Odtype.c @@ -66,9 +66,7 @@ static hbool_t interface_initialize_g = FALSE; * * Purpose: Decodes a data type * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, December 8, 1997 @@ -243,9 +241,7 @@ H5O_dtype_decode_helper(const uint8 **pp, H5T_t *dt) * * Purpose: Encodes a data type. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, December 8, 1997 @@ -538,7 +534,7 @@ H5O_dtype_decode(H5F_t __unused__ *f, const uint8 *p, const uint8 *p; IN: the raw information buffer const void *mesg; IN: Pointer to the simple datatype struct RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION This function encodes the native memory form of the simple datatype message in the "raw" disk form. @@ -667,9 +663,7 @@ H5O_dtype_size(H5F_t *f, const void *mesg) * Purpose: Frees resources within a data type message, but doesn't free * the message itself. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, December 9, 1997 @@ -705,9 +699,7 @@ H5O_dtype_reset(void *_mesg) * Purpose: Returns information about where the shared message is located * by filling in the SH shared message struct. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, June 1, 1998 @@ -744,9 +736,7 @@ H5O_dtype_get_share (H5F_t __unused__ *f, const void *_mesg, * * Purpose: Copies sharing information from SH into the message. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, June 4, 1998 @@ -786,7 +776,7 @@ H5O_dtype_set_share (H5F_t __unused__ *f, void *_mesg/*in,out*/, intn indent; IN: Amount to indent information by intn fwidth; IN: Field width (?) RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION This function prints debugging output to the stream passed as a parameter. diff --git a/src/H5Oefl.c b/src/H5Oefl.c index f961f57..5c1249c 100644 --- a/src/H5Oefl.c +++ b/src/H5Oefl.c @@ -136,9 +136,7 @@ H5O_efl_decode(H5F_t *f, const uint8 *p, H5O_shared_t __unused__ *sh) * * Purpose: Encodes a message. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, November 25, 1997 @@ -314,9 +312,7 @@ H5O_efl_size(H5F_t *f, const void *_mesg) * Purpose: Frees internal pointers and resets the message to an * initialial state. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, November 25, 1997 @@ -399,9 +395,7 @@ H5O_efl_total_size (H5O_efl_t *efl) * of any particular member of the external file list results in * zeros. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, March 4, 1998 @@ -485,9 +479,7 @@ H5O_efl_read (H5F_t __unused__ *f, const H5O_efl_t *efl, haddr_t *addr, * of any particular member of the external file list just * extends that file. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, March 4, 1998 @@ -570,9 +562,7 @@ H5O_efl_write (H5F_t __unused__ *f, const H5O_efl_t *efl, haddr_t *addr, * * Purpose: Prints debugging info for a message. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, November 25, 1997 diff --git a/src/H5Ofill.c b/src/H5Ofill.c index cdedf98..3755e7a 100644 --- a/src/H5Ofill.c +++ b/src/H5Ofill.c @@ -100,9 +100,7 @@ H5O_fill_decode(H5F_t *f, const uint8 *p, H5O_shared_t *sh) * * Purpose: Encode a fill value message. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, October 1, 1998 @@ -220,9 +218,7 @@ H5O_fill_size(H5F_t *f, const void *_mesg) * * Purpose: Resets a message to an initial state * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, October 1, 1998 @@ -255,9 +251,7 @@ H5O_fill_reset(void *_mesg) * * Purpose: Prints debugging info for the message. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, October 1, 1998 @@ -301,9 +295,7 @@ H5O_fill_debug(H5F_t *f, const void *_mesg, FILE *stream, intn indent, * value struct will be set to NULL to indicate that it has the * same type as the dataset. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, October 1, 1998 diff --git a/src/H5Olayout.c b/src/H5Olayout.c index ee37f3b..4d57cc3 100644 --- a/src/H5Olayout.c +++ b/src/H5Olayout.c @@ -120,9 +120,7 @@ H5O_layout_decode(H5F_t *f, const uint8 *p, H5O_shared_t __unused__ *sh) * * Purpose: Encodes a message. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, October 8, 1997 @@ -253,9 +251,7 @@ H5O_layout_size(H5F_t *f, const void *_mesg) * * Purpose: Prints debugging info for a message. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, October 8, 1997 diff --git a/src/H5Omtime.c b/src/H5Omtime.c index 8693032..f634184 100644 --- a/src/H5Omtime.c +++ b/src/H5Omtime.c @@ -161,9 +161,7 @@ H5O_mtime_decode(H5F_t __unused__ *f, const uint8 *p, * * Purpose: Encodes a modification time message. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -274,9 +272,7 @@ H5O_mtime_size(H5F_t __unused__ *f, const void __unused__ *mesg) * * Purpose: Prints debugging info for the message. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov diff --git a/src/H5Oname.c b/src/H5Oname.c index 420e6e5..00527d6 100644 --- a/src/H5Oname.c +++ b/src/H5Oname.c @@ -98,9 +98,7 @@ H5O_name_decode(H5F_t __unused__ *f, const uint8 *p, * * Purpose: Encodes a name message. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -177,7 +175,7 @@ H5O_name_copy(const void *_mesg, void *_dest) * * Return: Success: Message data size in bytes w/o alignment. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * matzke@llnl.gov @@ -209,9 +207,7 @@ H5O_name_size(H5F_t __unused__ *f, const void *_mesg) * Purpose: Frees internal pointers and resets the message to an * initial state. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -242,9 +238,7 @@ H5O_name_reset(void *_mesg) * * Purpose: Prints debugging info for the message. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov diff --git a/src/H5Osdspace.c b/src/H5Osdspace.c index adec06c..74634cc 100644 --- a/src/H5Osdspace.c +++ b/src/H5Osdspace.c @@ -161,7 +161,7 @@ H5O_sdspace_decode(H5F_t *f, const uint8 *p, H5O_shared_t __unused__ *sh) const uint8 *p; IN: the raw information buffer const void *mesg; IN: Pointer to the simple dimensionality struct RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION This function encodes the native memory form of the simple dimensionality message in the "raw" disk form. @@ -290,9 +290,7 @@ H5O_sdspace_copy(const void *mesg, void *dest) * Purpose: Frees the inside of a dataspace message and resets it to some * initial value. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, April 30, 1998 @@ -375,7 +373,7 @@ H5O_sdspace_size(H5F_t *f, const void *mesg) intn indent; IN: Amount to indent information by intn fwidth; IN: Field width (?) RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION This function prints debugging output to the stream passed as a parameter. diff --git a/src/H5Oshared.c b/src/H5Oshared.c index 198466b..c9cca9c 100644 --- a/src/H5Oshared.c +++ b/src/H5Oshared.c @@ -113,9 +113,7 @@ H5O_shared_decode (H5F_t *f, const uint8 *buf, H5O_shared_t __unused__ *sh) * * Purpose: Encodes message _MESG into buffer BUF. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, April 2, 1998 @@ -198,9 +196,7 @@ H5O_shared_size (H5F_t *f, const void __unused__ *_mesg) * * Purpose: Prints debugging info for the message * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, April 2, 1998 diff --git a/src/H5Ostab.c b/src/H5Ostab.c index 447bd58..80beed5 100644 --- a/src/H5Ostab.c +++ b/src/H5Ostab.c @@ -95,9 +95,7 @@ H5O_stab_decode(H5F_t *f, const uint8 *p, H5O_shared_t __unused__ *sh) * * Purpose: Encodes a symbol table message. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -239,9 +237,7 @@ H5O_stab_size(H5F_t *f, const void __unused__ *_mesg) * * Purpose: Prints debugging info for a symbol table message. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * matzke@llnl.gov @@ -44,7 +44,7 @@ USAGE herr_t H5P_init_interface() RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Initializes any interface-specific data or routines. @@ -104,7 +104,7 @@ H5P_init_interface(void) USAGE void H5P_term_interface() RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Release the atom group and any other resources allocated. GLOBAL VARIABLES @@ -134,7 +134,7 @@ H5P_term_interface(void) H5P_class_t type; IN: Property list class whose default is * desired. RETURNS - Property list ID or FAIL + Property list ID or Negative ERRORS ARGS BADVALUE Unknown property list class. @@ -219,7 +219,7 @@ H5Pcreate(H5P_class_t type) * * Return: Success: A new property list ID. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Wednesday, December 3, 1997 @@ -257,7 +257,7 @@ H5P_create(H5P_class_t type, void *plist) herr_t H5Pclose(oid) hid_t oid; IN: property list object to release access to RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION This function releases access to a property list object --------------------------------------------------------------------------*/ @@ -294,9 +294,7 @@ H5Pclose(hid_t plist_id) * Purpose: Closes a property list and frees the memory associated with * the property list. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, February 18, 1998 @@ -467,10 +465,10 @@ H5P_get_class(hid_t plist_id) * Any (or even all) of the output arguments can be null * pointers. * - * Return: Success: SUCCEED, version information is returned + * Return: Success: Non-negative, version information is returned * through the arguments. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Wednesday, January 7, 1998 @@ -509,9 +507,7 @@ H5Pget_version(hid_t plist_id, int *boot/*out*/, int *freelist/*out*/, * Purpose: Sets the userblock size field of a file creation property * list. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, January 6, 1998 @@ -555,9 +551,9 @@ H5Pset_userblock(hid_t plist_id, hsize_t size) * Purpose: Queries the size of a user block in a file creation property * list. * - * Return: Success: SUCCEED, size returned through SIZE argument. + * Return: Success: Non-negative, size returned through SIZE argument. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Wednesday, January 7, 1998 @@ -604,9 +600,7 @@ H5Pget_userblock(hid_t plist_id, hsize_t *size) * For MPI-IO and other parallel systems, choose an alignment * which is a multiple of the disk block size. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, June 9, 1998 @@ -649,9 +643,7 @@ H5Pset_alignment(hid_t fapl_id, hsize_t threshold, hsize_t alignment) * file access property list. The THRESHOLD and/or ALIGNMENT * pointers may be null pointers. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, June 9, 1998 @@ -691,9 +683,7 @@ H5Pget_alignment(hid_t fapl_id, hsize_t *threshold/*out*/, * file creation property list. A value of zero causes the * property to not change. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, January 6, 1998 @@ -746,9 +736,9 @@ H5Pset_sizes(hid_t plist_id, size_t sizeof_addr, size_t sizeof_size) * file according to a file creation property list. Either (or * even both) SIZEOF_ADDR and SIZEOF_SIZE may be null pointers. * - * Return: Success: SUCCEED, sizes returned through arguments. + * Return: Success: Non-negative, sizes returned through arguments. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Wednesday, January 7, 1998 @@ -799,9 +789,7 @@ H5Pget_sizes(hid_t plist_id, * Either (or even both) of IK and LK can be zero in which case * that value is left unchanged. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, January 6, 1998 @@ -842,9 +830,7 @@ H5Pset_sym_k(hid_t plist_id, int ik, int lk) * details. Either (or even both) IK and LK may be null * pointers. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, January 7, 1998 @@ -883,9 +869,7 @@ H5Pget_sym_k(hid_t plist_id, int *ik /*out */ , int *lk /*out */ ) * data. On average, such a tree will be 75% full, or have an * average rank of 1.5 times the value of IK. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, January 6, 1998 @@ -925,9 +909,9 @@ H5Pset_istore_k(hid_t plist_id, int ik) * H5Pset_istore_k() for details. The argument IK may be the * null pointer. * - * Return: Success: SUCCEED, size returned through IK + * Return: Success: Non-negative, size returned through IK * - * Failure: + * Failure: Negative * * Programmer: Robb Matzke * Wednesday, January 7, 1998 @@ -962,9 +946,7 @@ H5Pget_istore_k(hid_t plist_id, int *ik /*out */ ) * * Purpose: Sets the layout of raw data in the file. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, January 6, 1998 @@ -1004,7 +986,7 @@ H5Pset_layout(hid_t plist_id, H5D_layout_t layout) * * Return: Success: The layout type * - * Failure: H5D_LAYOUT_ERROR (-1, same as FAIL) + * Failure: H5D_LAYOUT_ERROR (negative) * * Programmer: Robb Matzke * Wednesday, January 7, 1998 @@ -1040,9 +1022,7 @@ H5Pget_layout(hid_t plist_id) * As a side effect, the layout method is changed to * H5D_CHUNKED. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, January 6, 1998 @@ -1105,7 +1085,7 @@ H5Pset_chunk(hid_t plist_id, int ndims, const hsize_t dim[/*ndims*/]) * * Return: Success: Positive Chunk dimensionality. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Wednesday, January 7, 1998 @@ -1157,9 +1137,7 @@ H5Pget_chunk(hid_t plist_id, int max_ndims, hsize_t dim[]/*out*/) * dataset can be extended (provided the data space also allows * the extending). * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, March 3, 1998 @@ -1241,7 +1219,7 @@ H5Pset_external(hid_t plist_id, const char *name, off_t offset, hsize_t size) * * Return: Success: Number of external files * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Tuesday, March 3, 1998 @@ -1287,9 +1265,7 @@ H5Pget_external_count(hid_t plist_id) * * See Also: H5Pset_external() * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, March 3, 1998 @@ -1372,9 +1348,7 @@ H5Pget_driver(hid_t plist_id) * in the stdio.h file: fopen(), fseek() or fseek64(), fread(), * fwrite(), and fclose(). * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, February 19, 1998 @@ -1413,9 +1387,7 @@ H5Pset_stdio(hid_t plist_id) * negative value. In the future, additional arguments may be * added to this function to match those added to H5Pset_stdio(). * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, February 26, 1998 @@ -1454,9 +1426,7 @@ H5Pget_stdio(hid_t plist_id) * in the unistd.h file: open(), lseek() or lseek64(), read(), * write(), and close(). * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, February 19, 1998 @@ -1495,9 +1465,7 @@ H5Pset_sec2(hid_t plist_id) * negative value. In the future, additional arguments may be * added to this function to match those added to H5Pset_sec2(). * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, February 26, 1998 @@ -1540,9 +1508,7 @@ H5Pget_sec2(hid_t plist_id) * INCREMENT results in fewer calls to realloc() and probably * less memory fragmentation. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, February 19, 1998 @@ -1588,9 +1554,7 @@ H5Pset_core(hid_t plist_id, size_t increment) * In the future, additional arguments may be added to this * function to match those added to H5Pset_core(). * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, February 26, 1998 @@ -1633,9 +1597,7 @@ H5Pget_core(hid_t plist_id, size_t *increment/*out*/) * Purpose: Set the low-level driver to split meta data from raw data, * storing meta data in one file and raw data in another file. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, February 19, 1998 @@ -1702,9 +1664,7 @@ H5Pset_split(hid_t plist_id, const char *meta_ext, hid_t meta_plist_id, * In the future, additional arguments may be added to this * function to match those added to H5Pset_sec2(). * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, February 26, 1998 @@ -1782,9 +1742,7 @@ H5Pget_split(hid_t plist_id, size_t meta_ext_size, char *meta_ext/*out*/, * meaningful when creating new files or opening families that * have only one member. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, February 19, 1998 @@ -1841,9 +1799,7 @@ H5Pset_family(hid_t plist_id, hsize_t memb_size, hid_t memb_plist_id) * members. In the future, additional arguments may be added to * this function to match those added to H5Pset_family(). * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, February 26, 1998 @@ -1902,9 +1858,7 @@ H5Pget_family(hid_t plist_id, hsize_t *memb_size/*out*/, * of one means fully read chunks are always preempted before * other chunks. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, May 19, 1998 @@ -1962,9 +1916,7 @@ H5Pset_cache(hid_t plist_id, int mdc_nelmts, * (or all) arguments may be null pointers in which case the * corresponding datum is not returned. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, May 19, 1998 @@ -2018,9 +1970,7 @@ H5Pget_cache(hid_t plist_id, int *mdc_nelmts, * If TCONV and/or BKG are null pointers then buffers will be * allocated and freed during the data transfer. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, March 16, 1998 @@ -2110,9 +2060,7 @@ H5Pget_buffer(hid_t plist_id, void **tconv/*out*/, void **bkg/*out*/) * The default is to cache blocks with no limit on block size * for serial I/O and to not cache blocks for parallel I/O * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Quincey Koziol * Monday, September 21, 1998 @@ -2149,9 +2097,7 @@ H5Pset_hyper_cache(hid_t plist_id, unsigned cache, unsigned limit) * * Purpose: Reads values previously set with H5Pset_hyper_cache(). * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Quincey Koziol * Monday, September 21, 1998 @@ -2193,9 +2139,7 @@ H5Pget_hyper_cache(hid_t plist_id, unsigned *cache/*out*/, * property to TRUE. Otherwise the I/O pipeline treats the * destination datapoints as completely uninitialized. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, March 17, 1998 @@ -2233,7 +2177,7 @@ H5Pset_preserve(hid_t plist_id, hbool_t status) * * Return: Success: TRUE or FALSE * - * Failure: -1 + * Failure: Negative * * Programmer: Robb Matzke * Tuesday, March 17, 1998 @@ -2288,9 +2232,7 @@ H5Pget_preserve(hid_t plist_id) * pipeline. That is, PLIST_ID must be a dataset creation * property list. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, April 15, 1998 @@ -2356,7 +2298,7 @@ H5Pset_filter(hid_t plist_id, H5Z_filter_t filter, unsigned int flags, * * Return: Success: Number of filters or zero if there are none. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Tuesday, August 4, 1998 @@ -2403,7 +2345,7 @@ H5Pget_nfilters(hid_t plist_id) * * Return: Success: Filter identification number. * - * Failure: H5Z_FILTER_ERROR (-1) + * Failure: H5Z_FILTER_ERROR (Negative) * * Programmer: Robb Matzke * Wednesday, April 15, 1998 @@ -2494,9 +2436,7 @@ H5Pget_filter(hid_t plist_id, int idx, unsigned int *flags/*out*/, * are faster but result in less compression. This is the same * algorithm as used by the GNU gzip program. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, April 15, 1998 @@ -2544,10 +2484,10 @@ H5Pset_deflate(hid_t plist_id, unsigned level) * * Purpose: Queries B-tree split ratios. See H5Pset_btree_ratios(). * - * Return: Success: SUCCEED with split ratios returned through + * Return: Success: Non-negative with split ratios returned through * the non-null arguments. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Monday, September 28, 1998 @@ -2594,9 +2534,7 @@ H5Pget_btree_ratios(hid_t plist_id, double *left/*out*/, double *middle/*out*/, * in the tree uses the RIGHT ratio when it splits. All ratios * are real numbers between 0 and 1, inclusive. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, September 28, 1998 @@ -2644,9 +2582,7 @@ H5Pset_btree_ratios(hid_t plist_id, double left, double middle, * to convert VALUE to the dataset type when the dataset is * created. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, October 1, 1998 @@ -2704,9 +2640,7 @@ H5Pset_fill_value(hid_t plist_id, hid_t type_id, const void *value) * value will be converted from its current data type to the * specified TYPE. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, October 1, 1998 @@ -2847,9 +2781,7 @@ H5Pget_fill_value(hid_t plist_id, hid_t type_id, void *value/*out*/) * to the access property list. Users should call this * function again to setup the property list. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Albert Cheng * Feb 3, 1998 @@ -2909,9 +2841,7 @@ H5Pset_mpi(hid_t plist_id, MPI_Comm comm, MPI_Info info) * negative value. In the future, additional arguments may be * added to this function to match those added to H5Pset_mpi(). * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, February 26, 1998 @@ -2977,9 +2907,7 @@ H5Pget_mpi(hid_t plist_id, MPI_Comm *comm, MPI_Info *info) * independent is the default mode. * * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Albert Cheng * April 2, 1998 @@ -3027,9 +2955,7 @@ H5Pset_xfer(hid_t plist_id, H5D_transfer_t data_xfer_mode) * This function is available only in the parallel HDF5 library * and is not a collective function. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Albert Cheng * April 2, 1998 @@ -3069,7 +2995,7 @@ H5Pget_xfer(hid_t plist_id, H5D_transfer_t *data_xfer_mode) hid_t H5P_copy(plist_id) hid_t plist_id; IN: property list object to copy RETURNS - Returns property list ID (atom) on success, FAIL on failure + Returns property list ID (atom) on success, Negative on failure ERRORS ARGS BADRANGE Unknown property list class. @@ -46,7 +46,7 @@ USAGE herr_t H5R_init_interface() RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Initializes any interface-specific data or routines. @@ -59,7 +59,7 @@ H5R_init_interface(void) /* Initialize the atom group for the file IDs */ if ((ret_value = H5I_init_group(H5I_REFERENCE, H5I_REFID_HASHSIZE, - H5R_RESERVED_ATOMS, (herr_t (*)(void *)) NULL)) != FAIL) { + H5R_RESERVED_ATOMS, (herr_t (*)(void *)) NULL)) >= 0) { ret_value = H5_add_exit(&H5R_term_interface); } @@ -108,7 +108,7 @@ H5R_term_interface(void) Region references. RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Creates a particular type of reference specified with REF_TYPE, in the space pointed to by REF. The LOC_ID and NAME are used to locate the object @@ -183,7 +183,7 @@ done: Region references. RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Creates a particular type of reference specified with REF_TYPE, in the space pointed to by REF. The LOC_ID and NAME are used to locate the object @@ -239,7 +239,7 @@ done: void *ref; IN: Reference to open. RETURNS - Valid ID on success, FAIL on failure + Valid ID on success, Negative on failure DESCRIPTION Given a reference to some object, open that object and return an ID for that object. @@ -303,7 +303,7 @@ done: void *ref; IN: Reference to open. RETURNS - Valid ID on success, FAIL on failure + Valid ID on success, Negative on failure DESCRIPTION Given a reference to some object, open that object and return an ID for that object. @@ -384,7 +384,7 @@ done: void *ref; IN: Reference to open. RETURNS - Valid ID on success, FAIL on failure + Valid ID on success, Negative on failure DESCRIPTION Given a reference to some object, creates a copy of the dataset pointed to's dataspace and defines a selection in the copy which is the region @@ -62,9 +62,7 @@ static herr_t H5RA_fix_overflow(H5RA_t *ra, H5T_t *type, H5RA_meta_t *meta, * * Purpose: Initialize the interface. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, August 25, 1998 @@ -148,7 +146,7 @@ H5RA_term_interface(void) * * Return: Success: A ragged array ID. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Tuesday, August 25, 1998 @@ -355,7 +353,7 @@ H5RA_create(H5G_entry_t *loc, const char *name, H5T_t *type, * * Return: Success: An array ID * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Tuesday, August 25, 1998 @@ -469,9 +467,7 @@ H5RA_open(H5G_entry_t *loc, const char *name) * * Purpose: Close a ragged array. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, August 25, 1998 @@ -511,9 +507,7 @@ H5RAclose(hid_t array_id) * * Purpose: Close a ragged array * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, August 25, 1998 @@ -550,9 +544,7 @@ H5RA_close(H5RA_t *ra) * of the ragged array contains SIZE[] elements of type TYPE_ID * and each row is stored in a buffer pointed to by BUF[]. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, August 25, 1998 @@ -613,9 +605,7 @@ H5RAwrite(hid_t array_id, hssize_t start_row, hsize_t nrows, * of the ragged array contains SIZE[] elements of type TYPE_ID * and each row is stored in a buffer pointed to by BUF[]. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, August 25, 1998 @@ -774,9 +764,7 @@ H5RA_write(H5RA_t *ra, hssize_t start_row, hsize_t nrows, H5T_t *type, * pointer to those elements. The first part of the row has * already been written to the raw dataset. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, August 26, 1998 @@ -903,14 +891,14 @@ H5RA_fix_overflow(H5RA_t *ra, H5T_t *type, H5RA_meta_t *meta, hsize_t nelmts, * input value of SIZE[] is irrelevant in this case) and the * library will allocate memory for each row by calling malloc(). * - * Return: Success: SUCCEED. The values of the SIZE[] array will + * Return: Success: Non-negative. The values of the SIZE[] array will * be the true length of each row. If a row is * longer than the caller-allocated length then * SIZE[] will contain the true length of the * row although not all elements of that row * will be stored in the buffer. * - * Failure: FAIL. The BUF[] array will contain it's + * Failure: Negative. The BUF[] array will contain it's * original pointers (null or otherwise) * although the caller-supplied buffers may have * been modified. The SIZE[] array may also be @@ -965,9 +953,7 @@ H5RAread(hid_t array_id, hssize_t start_row, hsize_t nrows, * * Purpose: Reads (part of) a ragged array. See H5RAread() for details. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, August 26, 1998 @@ -53,7 +53,7 @@ USAGE herr_t H5S_init_interface() RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Initializes any interface-specific data or routines. @@ -66,7 +66,7 @@ H5S_init_interface(void) /* Initialize the atom group for the file IDs */ if ((ret_value = H5I_init_group(H5I_DATASPACE, H5I_DATASPACEID_HASHSIZE, - H5S_RESERVED_ATOMS, (herr_t (*)(void *)) H5S_close)) != FAIL) { + H5S_RESERVED_ATOMS, (herr_t (*)(void *)) H5S_close)) >= 0) { ret_value = H5_add_exit(&H5S_term_interface); } @@ -100,7 +100,7 @@ H5S_init_interface(void) USAGE void H5S_term_interface() RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Release the atom group and any other resources allocated. GLOBAL VARIABLES @@ -224,9 +224,7 @@ H5S_term_interface(void) * memory conversion info. The FCONV and MCONV arguments are * not copied. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, August 11, 1998 @@ -342,9 +340,7 @@ done: * * Purpose: Releases all memory associated with a dataspace extent. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Quincey Koziol * Thursday, July 23, 1998 @@ -390,9 +386,7 @@ H5S_extent_release(H5S_t *ds) * * Purpose: Releases all memory associated with a data space. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, December 9, 1997 @@ -429,9 +423,7 @@ H5S_close(H5S_t *ds) * * Purpose: Release access to a data space object. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Errors: * @@ -466,9 +458,7 @@ H5Sclose(hid_t space_id) * Purpose: Releases all memory associated with a simple data space. * (but doesn't free the simple space itself) * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Quincey Koziol * Friday, April 17, 1998 @@ -499,7 +489,7 @@ H5S_release_simple(H5S_simple_t *simple) * * Return: Success: ID of the new dataspace * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Friday, January 30, 1998 @@ -542,7 +532,7 @@ H5Scopy(hid_t space_id) * * Purpose: Copies a dataspace extent. * - * Return: SUCCEED/FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Quincey Koziol * Thursday, July 23, 1998 @@ -582,7 +572,7 @@ H5Sextent_copy(hid_t dst_id,hid_t src_id) * * Purpose: Copies a dataspace extent * - * Return: SUCCEED/FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Quincey Koziol * Wednesday, June 3, 1998 @@ -839,7 +829,7 @@ H5S_get_npoints_max(const H5S_t *ds) * * Return: Success: The number of dimensions in a data space. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Thursday, December 11, 1997 @@ -875,7 +865,7 @@ H5Sget_simple_extent_ndims(hid_t space_id) * Return: Success: Non-negative number of dimensions. Zero * implies a scalar. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Thursday, December 11, 1997 @@ -925,7 +915,7 @@ H5S_get_simple_extent_ndims(const H5S_t *ds) * Return: Success: Number of dimensions, the same value as * returned by H5Sget_simple_extent_ndims(). * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Thursday, December 11, 1997 @@ -966,7 +956,7 @@ H5Sget_simple_extent_dims(hid_t space_id, hsize_t dims[]/*out*/, * * Return: Success: Number of dimensions. Zero implies scalar. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Thursday, December 11, 1997 @@ -1025,9 +1015,7 @@ H5S_get_simple_extent_dims(const H5S_t *ds, hsize_t dims[], hsize_t max_dims[]) * Purpose: Updates a data space by writing a message to an object * header. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, December 9, 1997 @@ -1264,7 +1252,7 @@ H5Sis_simple(hid_t space_id) const size_t *max; IN: Maximum size of each dimension for the dataspace RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION This function sets the number and size of each dimension in the dataspace. Setting RANK to a value of zero converts the dataspace to a @@ -1337,9 +1325,7 @@ H5Sset_extent_simple(hid_t space_id, int rank, const hsize_t dims[/*rank*/], * Purpose: This is where the real work happens for * H5Sset_extent_simple(). * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke (copied from H5Sset_extent_simple) * Wednesday, July 8, 1998 @@ -1430,7 +1416,7 @@ H5S_set_extent_simple (H5S_t *space, int rank, const hsize_t *dims, * Quincey Koziol * Instead of returning a point into the data space conversion table we * copy all the information into a user-supplied CONV buffer and return - * SUCCEED or FAIL. + * non-negative on success or negative on failure. * * Robb Matzke, 11 Aug 1998 * Returns a pointer into the conversion path table. A path entry @@ -1523,7 +1509,7 @@ H5S_find (const H5S_t *mem_space, const H5S_t *file_space) * * Return: Success: Number of dimensions whose size increased. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Friday, January 30, 1998 @@ -1581,7 +1567,7 @@ H5S_extend (H5S_t *space, const hsize_t *size) * * Return: Success: The ID for the new simple data space object. * - * Failure: FAIL + * Failure: Negative * * Errors: * @@ -1693,7 +1679,7 @@ H5Sget_simple_extent_type(hid_t sid) herr_t H5Sset_extent_none(space_id) hid_t space_id; IN: Dataspace object to reset RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION This function resets the type of a dataspace back to "none" with no extent information stored for the dataspace. @@ -1730,7 +1716,7 @@ H5Sset_extent_none(hid_t space_id) hid_t space_id; IN: Dataspace object to reset const hssize_t *offset; IN: Offset to position the selection at RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION This function creates an offset for the selection within an extent, allowing the same shaped selection to be moved to different locations within a @@ -1771,9 +1757,7 @@ H5Soffset_simple(hid_t space_id, const hssize_t *offset) * * Purpose: Prints debugging information about a data space. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, July 21, 1998 diff --git a/src/H5Sall.c b/src/H5Sall.c index c798a61..638e5a0 100644 --- a/src/H5Sall.c +++ b/src/H5Sall.c @@ -246,9 +246,7 @@ H5S_all_fgath (H5F_t *f, const struct H5O_layout_t *layout, * LAYOUT and EFL. Each element is ELMT_SIZE bytes. * The caller is requesting that NELMTS elements are copied. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Quincey Koziol * Tuesday, June 16, 1998 @@ -422,9 +420,7 @@ H5S_all_mgath (const void *_buf, size_t elmt_size, * ELMT_SIZE bytes and they are organized in application memory * according to MEM_SPACE. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Quincey Koziol * Wednesday, June 17, 1998 @@ -514,7 +510,7 @@ H5S_all_mscat (const void *_tconv_buf, size_t elmt_size, herr_t H5S_all_release(space) H5S_t *space; IN: Pointer to dataspace RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Releases "all" selection information for a dataspace GLOBAL VARIABLES diff --git a/src/H5Shyper.c b/src/H5Shyper.c index c19a76b..b5e383c 100644 --- a/src/H5Shyper.c +++ b/src/H5Shyper.c @@ -416,9 +416,7 @@ H5S_hyper_get_regions (size_t *num_regions, intn dim, size_t bound_count, * * Purpose: Cache a hyperslab block for reading or writing. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Quincey Koziol * Monday, September 21, 1998 @@ -481,9 +479,7 @@ H5S_hyper_block_cache (H5S_hyper_node_t *node, * * Purpose: Read in data from a cached hyperslab block * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Quincey Koziol * Monday, September 21, 1998 @@ -533,9 +529,7 @@ H5S_hyper_block_read (H5S_hyper_node_t *node, H5S_hyper_fhyper_info_t *fhyper_in * * Purpose: Write out data to a cached hyperslab block * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Quincey Koziol * Monday, September 21, 1998 @@ -648,7 +642,7 @@ H5S_hyper_fread (intn dim, H5S_hyper_fhyper_info_t *fhyper_info) if((reg_id=H5S_hyper_get_regions(&num_regions,dim, fhyper_info->space->select.sel_info.hyper.hyper_lst->count, fhyper_info->lo_bounds, fhyper_info->hi_bounds, - fhyper_info->iter->hyp.pos,fhyper_info->space->select.offset))!=FAIL) { + fhyper_info->iter->hyp.pos,fhyper_info->space->select.offset))>=0) { /* Get the pointer to the actual regions array */ regions=H5TB_buf_ptr(reg_id); @@ -929,7 +923,7 @@ H5S_hyper_fwrite (intn dim, H5S_hyper_fhyper_info_t *fhyper_info) if((reg_id=H5S_hyper_get_regions(&num_regions,dim, fhyper_info->space->select.sel_info.hyper.hyper_lst->count, fhyper_info->lo_bounds, fhyper_info->hi_bounds, - fhyper_info->iter->hyp.pos,fhyper_info->space->select.offset))!=FAIL) { + fhyper_info->iter->hyp.pos,fhyper_info->space->select.offset))>=0) { /* Get the pointer to the actual regions array */ regions=H5TB_buf_ptr(reg_id); @@ -1061,9 +1055,7 @@ H5S_hyper_fwrite (intn dim, H5S_hyper_fhyper_info_t *fhyper_info) * LAYOUT and EFL. Each element is ELMT_SIZE bytes. * The caller is requesting that NELMTS elements are copied. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Quincey Koziol * Tuesday, June 16, 1998 @@ -1191,7 +1183,7 @@ H5S_hyper_mread (intn dim, H5S_hyper_fhyper_info_t *fhyper_info) if((reg_id=H5S_hyper_get_regions(&num_regions,dim, fhyper_info->space->select.sel_info.hyper.hyper_lst->count, fhyper_info->lo_bounds, fhyper_info->hi_bounds, - fhyper_info->iter->hyp.pos,fhyper_info->space->select.offset))!=FAIL) { + fhyper_info->iter->hyp.pos,fhyper_info->space->select.offset))>=0) { /* Get the pointer to the actual regions array */ regions=H5TB_buf_ptr(reg_id); @@ -1464,7 +1456,7 @@ H5S_hyper_mwrite (intn dim, H5S_hyper_fhyper_info_t *fhyper_info) if((reg_id=H5S_hyper_get_regions(&num_regions,dim, fhyper_info->space->select.sel_info.hyper.hyper_lst->count, fhyper_info->lo_bounds, fhyper_info->hi_bounds, - fhyper_info->iter->hyp.pos,fhyper_info->space->select.offset))!=FAIL) { + fhyper_info->iter->hyp.pos,fhyper_info->space->select.offset))>=0) { /* Get the pointer to the actual regions array */ regions=H5TB_buf_ptr(reg_id); @@ -1592,9 +1584,7 @@ H5S_hyper_mwrite (intn dim, H5S_hyper_fhyper_info_t *fhyper_info) * ELMT_SIZE bytes and they are organized in application memory * according to MEM_SPACE. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Quincey Koziol * Wednesday, June 17, 1998 @@ -1739,7 +1729,7 @@ H5S_hyper_bsearch(hssize_t size, H5S_hyper_bound_t *barr, size_t count) const hssize_t *start; IN: Offset of block const hsize_t *size; IN: Size of block RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Adds a new hyperslab node to a list of them. GLOBAL VARIABLES @@ -1796,7 +1786,7 @@ done: H5S_hyper_node_t **head; IN: Pointer to pointer to head of hyperslab list H5S_hyper_node_t *node; IN: Pointer to node to prepend RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Prepends an existing hyperslab node to a list of them. GLOBAL VARIABLES @@ -1833,7 +1823,7 @@ H5S_hyper_node_prepend (H5S_hyper_node_t **head, H5S_hyper_node_t *node) const hssize_t *start; IN: Offset of block const hsize_t *end; IN: Offset of end of block RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Adds a block to an existing hyperslab selection. GLOBAL VARIABLES @@ -2043,7 +2033,7 @@ done: H5S_hyper_node_t **uniq; IN: Handle to list of non-overlapping nodes H5S_hyper_node_t **overlap; IN: Handle to list of overlapping nodes RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Clips a list of hyperslab nodes against the current hyperslab selection. The list of non-overlapping and overlapping nodes which are generated from @@ -2286,7 +2276,7 @@ done: herr_t H5S_hyper_release(space) H5S_t *space; IN: Pointer to dataspace RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Releases all hyperslab selection information for a dataspace GLOBAL VARIABLES @@ -2392,7 +2382,7 @@ H5S_hyper_npoints (const H5S_t *space) H5S_t *space; IN: Pointer to dataspace iterator is for H5S_sel_iter_t *sel_iter; IN: Pointer to selection iterator RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Releases all information for a dataspace hyperslab selection iterator GLOBAL VARIABLES @@ -2452,7 +2442,7 @@ H5S_hyper_compare_bounds (const void *r1, const void *r2) H5S_t *dst; OUT: Pointer to the destination dataspace H5S_t *src; IN: Pointer to the source dataspace RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Copies all the hyperslab selection information from the source dataspace to the destination dataspace. @@ -2599,7 +2589,7 @@ done: H5S_t *space; IN: Dataspace pointer to query RETURNS TRUE if the selection fits within the extent, FALSE if it does not and - FAIL on an error. + Negative on an error. DESCRIPTION Determines if the current selection at the current offet fits within the extent for the dataspace. diff --git a/src/H5Spoint.c b/src/H5Spoint.c index 11aa324..560d0a2 100644 --- a/src/H5Spoint.c +++ b/src/H5Spoint.c @@ -116,7 +116,7 @@ H5S_point_init (const struct H5O_layout_t __unused__ *layout, size_t num_elem; IN: Number of elements in COORD array. const hssize_t *coord[]; IN: The location of each element selected RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION This function adds elements to the current point selection for a dataspace GLOBAL VARIABLES @@ -362,9 +362,7 @@ H5S_point_fgath (H5F_t *f, const struct H5O_layout_t *layout, * LAYOUT and EFL. Each element is ELMT_SIZE bytes. * The caller is requesting that NELMTS elements are copied. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Quincey Koziol * Tuesday, June 16, 1998 @@ -557,9 +555,7 @@ H5S_point_mgath (const void *_buf, size_t elmt_size, * ELMT_SIZE bytes and they are organized in application memory * according to MEM_SPACE. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Quincey Koziol * Wednesday, June 17, 1998 @@ -639,7 +635,7 @@ H5S_point_mscat (const void *_tconv_buf, size_t elmt_size, herr_t H5S_point_release(space) H5S_t *space; IN: Pointer to dataspace RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Releases all point selection information for a dataspace GLOBAL VARIABLES @@ -716,7 +712,7 @@ H5S_point_npoints (const H5S_t *space) H5S_t *dst; OUT: Pointer to the destination dataspace H5S_t *src; IN: Pointer to the source dataspace RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Copies all the point selection information from the source dataspace to the destination dataspace. @@ -796,7 +792,7 @@ done: H5S_t *space; IN: Dataspace pointer to query RETURNS TRUE if the selection fits within the extent, FALSE if it does not and - FAIL on an error. + Negative on an error. DESCRIPTION Determines if the current selection at the current offet fits within the extent for the dataspace. diff --git a/src/H5Sselect.c b/src/H5Sselect.c index f50cd03..73e5a4d 100644 --- a/src/H5Sselect.c +++ b/src/H5Sselect.c @@ -32,7 +32,7 @@ static void H5S_select_term(void); USAGE herr_t H5S_select_init(void) RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION GLOBAL VARIABLES COMMENTS, BUGS, ASSUMPTIONS @@ -58,7 +58,7 @@ H5S_select_init (void) USAGE void H5S_select_term() RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Release the selection resources allocated. GLOBAL VARIABLES @@ -82,7 +82,7 @@ H5S_select_term(void) H5S_t *dst; OUT: Pointer to the destination dataspace H5S_t *src; IN: Pointer to the source dataspace RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Copies all the selection information (include offset) from the source dataspace to the destination dataspace. @@ -164,7 +164,7 @@ H5S_select_copy (H5S_t *dst, const H5S_t *src) herr_t H5S_select_release(space) H5S_t *space; IN: Pointer to dataspace RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Releases all selection information for a dataspace GLOBAL VARIABLES @@ -223,7 +223,7 @@ H5S_select_release (H5S_t *space) const hssize_t *count; IN: Number of blocks included in hyperslab const hssize_t *block; IN: Size of block in hyperslab RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Combines a hyperslab selection with the current selection for a dataspace. If the current selection is not a hyperslab, it is freed and the hyperslab @@ -276,9 +276,7 @@ H5Sselect_hyperslab(hid_t space_id, H5S_seloper_t op, * * Purpose: Internal version of H5Sselect_hyperslab(). * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke (split from HSselect_hyperslab()). * Tuesday, August 25, 1998 @@ -534,7 +532,7 @@ done: size_t num_elem; IN: Number of elements in COORD array. const hssize_t **coord; IN: The location of each element selected RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION This function selects array elements to be included in the selection for the dataspace. The COORD array is a 2-D array of size <dataspace rank> @@ -623,7 +621,7 @@ done: herr_t H5Sselect_elements(dsid) hid_t dsid; IN: Dataspace ID of selection to modify RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION This function selects the entire extent for a dataspace. GLOBAL VARIABLES @@ -667,7 +665,7 @@ done: herr_t H5Sselect_elements(dsid) hid_t dsid; IN: Dataspace ID of selection to modify RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION This function de-selects the entire extent for a dataspace. GLOBAL VARIABLES @@ -800,7 +798,7 @@ H5S_get_select_npoints (const H5S_t *space) const H5S_t *space; IN: Pointer to dataspace iterator is for H5S_sel_iter_t *sel_iter; IN: Pointer to selection iterator RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Releases all information for a dataspace selection iterator GLOBAL VARIABLES @@ -851,7 +849,7 @@ H5S_sel_iter_release (const H5S_t *space, H5S_sel_iter_t *sel_iter) hid_t dsid; IN: Dataspace ID to query RETURNS TRUE if the selection fits within the extent, FALSE if it does not and - FAIL on an error. + Negative on an error. DESCRIPTION Determines if the current selection at the current offet fits within the extent for the dataspace. @@ -891,7 +889,7 @@ H5Sselect_valid(hid_t spaceid) H5S_t *space; IN: Dataspace pointer to query RETURNS TRUE if the selection fits within the extent, FALSE if it does not and - FAIL on an error. + Negative on an error. DESCRIPTION Determines if the current selection at the current offet fits within the extent for the dataspace. @@ -113,7 +113,7 @@ USAGE herr_t H5T_init_interface() RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Initializes any interface-specific data or routines. @@ -130,7 +130,7 @@ H5T_init_interface(void) /* Initialize the atom group for the file IDs */ if ((ret_value = H5I_init_group(H5I_DATATYPE, H5I_DATATYPEID_HASHSIZE, H5T_RESERVED_ATOMS, - (herr_t (*)(void *)) H5T_close)) != FAIL) { + (herr_t (*)(void *)) H5T_close)) >= 0) { ret_value = H5_add_exit(&H5T_term_interface); } @@ -684,9 +684,7 @@ H5T_init_interface(void) * called when the library is closing in order to unlock all * registered data types and thus make them free-able. * - * Return: Success: 0 - * - * Failure: 0 + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, April 27, 1998 @@ -716,7 +714,7 @@ H5T_unlock_cb (void *_dt, const void __unused__ *key) USAGE void H5T_term_interface() RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Release the atom group and any other resources allocated. GLOBAL VARIABLES @@ -856,7 +854,7 @@ H5T_term_interface(void) * * Return: Success: A new type identifier. * - * Failure: FAIL + * Failure: Negative * * Errors: * ARGS BADVALUE Invalid size. @@ -906,7 +904,7 @@ H5Tcreate(H5T_class_t type, size_t size) * * Return: Success: Object ID of the named data type. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Monday, June 1, 1998 @@ -956,9 +954,7 @@ H5Topen(hid_t loc_id, const char *name) * Purpose: Save a transient data type to a file and turn the type handle * into a named, immutable type. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, June 1, 1998 @@ -1005,7 +1001,7 @@ H5Tcommit(hid_t loc_id, const char *name, hid_t type_id) * * Return: Success: TRUE if committed, FALSE otherwise. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Thursday, June 4, 1998 @@ -1041,7 +1037,7 @@ H5Tcommitted(hid_t type_id) * * Return: Success: The ID of a new data type. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Tuesday, December 9, 1997 @@ -1112,9 +1108,7 @@ H5Tcopy(hid_t type_id) * * Purpose: Frees a data type and all associated memory. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, December 9, 1997 @@ -1156,7 +1150,7 @@ H5Tclose(hid_t type_id) * * Return: Success: TRUE if equal, FALSE if unequal * - * Failure: FAIL + * Failure: Negative * * Errors: * @@ -1201,9 +1195,7 @@ H5Tequal(hid_t type1_id, hid_t type2_id) * Once a data type is locked it can never be unlocked unless * the entire library is closed. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, January 9, 1998 @@ -1250,7 +1242,7 @@ H5Tlock(hid_t type_id) * Return: Success: One of the non-negative data type class * constants. * - * Failure: H5T_NO_CLASS (-1, same as FAIL) + * Failure: H5T_NO_CLASS (Negative) * * Programmer: Robb Matzke * Monday, December 8, 1997 @@ -1334,9 +1326,7 @@ H5Tget_size(hid_t type_id) * * All data types have a positive size. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, January 7, 1998 @@ -1434,7 +1424,7 @@ H5Tset_size(hid_t type_id, size_t size) * * Return: Success: A byte order constant * - * Failure: H5T_ORDER_ERROR (-1, same as FAIL) + * Failure: H5T_ORDER_ERROR (Negative) * * Programmer: Robb Matzke * Wednesday, January 7, 1998 @@ -1472,9 +1462,7 @@ H5Tget_order(hid_t type_id) * * Purpose: Sets the byte order for an atomic data type. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, January 7, 1998 @@ -1571,9 +1559,7 @@ H5Tget_precision(hid_t type_id) * the locations and sizes of the sign, mantissa, and exponent * fields first. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, January 7, 1998 @@ -1737,9 +1723,7 @@ H5Tget_offset(hid_t type_id) * The offset of an H5T_STRING cannot be set to anything but * zero. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, January 7, 1998 @@ -1789,9 +1773,7 @@ H5Tset_offset(hid_t type_id, size_t offset) * pad type and returns their values through the LSB and MSB * arguments, either of which may be the null pointer. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, January 9, 1998 @@ -1828,9 +1810,7 @@ H5Tget_pad(hid_t type_id, H5T_pad_t *lsb/*out*/, H5T_pad_t *msb/*out*/) * * Purpose: Sets the LSB and MSB pad types. * - * Return: Success: - * - * Failure: + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, January 9, 1998 @@ -1875,7 +1855,7 @@ H5Tset_pad(hid_t type_id, H5T_pad_t lsb, H5T_pad_t msb) * * Return: Success: The sign type. * - * Failure: H5T_SGN_ERROR (-1, same as FAIL) + * Failure: H5T_SGN_ERROR (Negative) * * Programmer: Robb Matzke * Wednesday, January 7, 1998 @@ -1913,9 +1893,7 @@ H5Tget_sign(hid_t type_id) * * Purpose: Sets the sign property for an integer. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, January 7, 1998 @@ -1961,10 +1939,10 @@ H5Tset_sign(hid_t type_id, H5T_sign_t sign) * * Any (or even all) of the arguments can be null pointers. * - * Return: Success: SUCCEED, field locations and sizes are + * Return: Success: Non-negative, field locations and sizes are * returned through the arguments. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Wednesday, January 7, 1998 @@ -2013,9 +1991,7 @@ H5Tget_fields(hid_t type_id, size_t *spos/*out*/, * Fields are not allowed to extend beyond the number of bits of * precision, nor are they allowed to overlap with one another. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, January 7, 1998 @@ -2127,9 +2103,7 @@ H5Tget_ebias(hid_t type_id) * * Purpose: Sets the exponent bias of a floating-point type. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, January 7, 1998 @@ -2172,7 +2146,7 @@ H5Tset_ebias(hid_t type_id, size_t ebias) * * Return: Success: Normalization ID * - * Failure: H5T_NORM_ERROR (-1, same as FAIL) + * Failure: H5T_NORM_ERROR (Negative) * * Programmer: Robb Matzke * Wednesday, January 7, 1998 @@ -2211,9 +2185,7 @@ H5Tget_norm(hid_t type_id) * Purpose: Sets the mantissa normalization method for a floating point * data type. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, January 7, 1998 @@ -2260,7 +2232,7 @@ H5Tset_norm(hid_t type_id, H5T_norm_t norm) * * Return: Success: The internal padding type. * - * Failure: H5T_PAD_ERROR (-1, same as FAIL) + * Failure: H5T_PAD_ERROR (Negative) * * Programmer: Robb Matzke * Friday, January 9, 1998 @@ -2301,9 +2273,7 @@ H5Tget_inpad(hid_t type_id) * sign, exponent, or mantissa) then they will be filled * according to the value of this property. * - * Return: Success: - * - * Failure: + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, January 9, 1998 @@ -2350,7 +2320,7 @@ H5Tset_inpad(hid_t type_id, H5T_pad_t pad) * * Return: Success: The character set of an H5T_STRING type. * - * Failure: H5T_CSET_ERROR (-1, same as FAIL) + * Failure: H5T_CSET_ERROR (Negative) * * Programmer: Robb Matzke * Friday, January 9, 1998 @@ -2390,9 +2360,7 @@ H5Tget_cset(hid_t type_id) * different nationalities and to convert between them to the * extent possible. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, January 9, 1998 @@ -2439,7 +2407,7 @@ H5Tset_cset(hid_t type_id, H5T_cset_t cset) * * Return: Success: The character set of an H5T_STRING type. * - * Failure: H5T_STR_ERROR (-1, same as FAIL) + * Failure: H5T_STR_ERROR (Negative) * * Programmer: Robb Matzke * Friday, January 9, 1998 @@ -2490,9 +2458,7 @@ H5Tget_strpad(hid_t type_id) * long string is padded on the end by appending nulls or * spaces. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, January 9, 1998 @@ -2536,7 +2502,7 @@ H5Tset_strpad(hid_t type_id, H5T_str_t strpad) * Return: Success: Number of members defined in a compound data * type. * - * Failure: FAIL + * Failure: Negative * * Errors: * @@ -2667,7 +2633,7 @@ H5Tget_member_offset(hid_t type_id, int membno) * * Return: Success: A value between zero and four, inclusive. * - * Failure: -1 + * Failure: Negative * * Programmer: Robb Matzke * Wednesday, January 7, 1998 @@ -2718,7 +2684,7 @@ H5Tget_member_dims(hid_t type_id, int membno, * modifying the returned data type does not * modify the member type. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Wednesday, January 7, 1998 @@ -2779,11 +2745,11 @@ H5Tget_member_type(hid_t type_id, int membno) * compound data type cannot have a member which is a compound * data type. * - * Return: Success: SUCCEED, the PARENT_ID compound data type is + * Return: Success: Non-negative, the PARENT_ID compound data type is * modified to include a copy of the member type * MEMBER_ID. * - * Failure: FAIL + * Failure: Negative * * Errors: * @@ -2841,9 +2807,7 @@ H5Tinsert(hid_t parent_id, const char *name, size_t offset, hid_t member_id) * array with NDIMS dimensionality and the size of the array is * DIMS. The total member size should be relatively small. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, July 7, 1998 @@ -2909,9 +2873,7 @@ H5Tinsert_array(hid_t parent_id, const char *name, size_t offset, * Purpose: Recursively removes padding from within a compound data type * to make it more efficient (space-wise) to store that data. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, January 7, 1998 @@ -2962,9 +2924,7 @@ H5Tpack(hid_t type_id) * are then used when determining which conversion function is * appropriate for this path. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, January 9, 1998 @@ -3026,9 +2986,7 @@ H5Tregister_hard(const char *name, hid_t src_id, hid_t dst_id, * of the master soft list and replacing the soft function in * all applicable existing conversion paths. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, January 13, 1998 @@ -3153,9 +3111,7 @@ H5Tregister_soft(const char *name, H5T_class_t src_cls, H5T_class_t dst_cls, * * Purpose: Removes FUNC from all conversion paths. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, January 13, 1998 @@ -3331,9 +3287,7 @@ H5Tfind(hid_t src_id, hid_t dst_id, H5T_cdata_t **pcdata) * fields already initialized and the conversion of BUF supplies * the `c' and `d' field values). * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, June 10, 1998 @@ -3431,9 +3385,7 @@ H5Tget_overflow(void) * documentation of arguments and return values. The NULL * pointer may be passed to remove the overflow handler. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, July 7, 1998 @@ -3681,9 +3633,7 @@ H5T_copy(const H5T_t *old_dt, H5T_copy_t method) * Purpose: Commit a type, giving it a name and causing it to become * immutable. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, June 1, 1998 @@ -3763,9 +3713,7 @@ H5T_commit (H5G_entry_t *loc, const char *name, H5T_t *type) * This function is a no-op if the type is not transient or if * the type is already read-only or immutable. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, June 4, 1998 @@ -3804,9 +3752,7 @@ H5T_lock (H5T_t *dt, hbool_t immutable) * Purpose: Frees a data type and all associated memory. If the data * type is locked then nothing happens. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, December 8, 1997 @@ -3865,7 +3811,7 @@ H5T_close(H5T_t *dt) * * Return: Success: TRUE, FALSE * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Wednesday, January 7, 1998 @@ -3923,9 +3869,7 @@ H5T_get_size(const H5T_t *dt) * instance of PARENT will have the member begin at byte offset * OFFSET from the beginning. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, December 8, 1997 @@ -4007,9 +3951,7 @@ H5T_insert(H5T_t *parent, const char *name, size_t offset, intn ndims, * Purpose: Recursively packs a compound data type by removing padding * bytes. This is done in place (that is, destructively). * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, January 7, 1998 @@ -4060,9 +4002,7 @@ H5T_pack(H5T_t *dt) * This even works for locked data types since it doesn't change * the value of the type. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, January 7, 1998 @@ -4695,9 +4635,7 @@ H5T_timer_end (H5_timer_t __unused__ *timer, H5T_cdata_t __unused__ *cdata, * * Purpose: Prints information about a data type. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, January 7, 1998 @@ -72,7 +72,7 @@ USAGE herr_t H5TB_init_interface() RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Initializes any interface-specific data or routines. @@ -85,7 +85,7 @@ H5TB_init_interface(void) /* Initialize the atom group for the file IDs */ if ((ret_value = H5I_init_group(H5I_TEMPBUF, H5I_TEMPBUFID_HASHSIZE, - H5TB_RESERVED_ATOMS, NULL)) != FAIL) { + H5TB_RESERVED_ATOMS, NULL)) >= 0) { ret_value = H5_add_exit(&H5TB_term_interface); } FUNC_LEAVE(ret_value); @@ -100,7 +100,7 @@ H5TB_init_interface(void) USAGE void H5TB_term_interface() RETURNS - SUCCEED/FAIL + Non-negative on success/Negative on failure DESCRIPTION Release the atom group and any other resources allocated. GLOBAL VARIABLES @@ -138,9 +138,7 @@ H5TB_term_interface(void) * * Purpose: Releases all memory associated with a temporary buffer. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Quincey Koziol * Thursday, June 11, 1998 diff --git a/src/H5Tbit.c b/src/H5Tbit.c index 4d1d796..8b0b53b 100644 --- a/src/H5Tbit.c +++ b/src/H5Tbit.c @@ -405,7 +405,7 @@ H5T_bit_find (uint8 *buf, size_t offset, size_t size, H5T_sdir_t direction, * Return: Success: The carry-out value, one if overflow zero * otherwise. * - * Failure: FAIL + * Failure: Negative * * Programmer: Robb Matzke * Friday, June 26, 1998 diff --git a/src/H5Tconv.c b/src/H5Tconv.c index bd3ac5c..f46524f 100644 --- a/src/H5Tconv.c +++ b/src/H5Tconv.c @@ -37,9 +37,7 @@ static intn interface_initialize_g = FALSE; * Purpose: The no-op conversion. The library knows about this * conversion without it being registered. * - * Return: Success: SUCCEED - * - * Failure: never fails + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, January 14, 1998 @@ -84,9 +82,7 @@ H5T_conv_noop(hid_t __unused__ src_id, hid_t __unused__ dst_id, * * Note: This is a soft conversion function. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, January 13, 1998 @@ -190,9 +186,7 @@ H5T_conv_order(hid_t src_id, hid_t dst_id, H5T_cdata_t *cdata, size_t nelmts, * already initialized then the member conversion functions * are recalculated. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Monday, January 26, 1998 @@ -368,9 +362,7 @@ H5T_conv_struct_init (H5T_t *src, H5T_t *dst, H5T_cdata_t *cdata) * * Copy BACKGROUND to BUF * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, January 22, 1998 @@ -566,9 +558,7 @@ H5T_conv_struct(hid_t src_id, hid_t dst_id, H5T_cdata_t *cdata, size_t nelmts, * function for integer conversions and is probably not * particularly fast. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Wednesday, June 10, 1998 @@ -924,9 +914,7 @@ H5T_conv_i_i (hid_t src_id, hid_t dst_id, H5T_cdata_t *cdata, * all for floating point conversions and is probably not * particularly fast! * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, June 23, 1998 @@ -1327,9 +1315,7 @@ H5T_conv_f_f (hid_t src_id, hid_t dst_id, H5T_cdata_t *cdata, * * Purpose: Convert one fixed-length string type to another. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, August 7, 1998 @@ -1556,9 +1542,7 @@ H5T_conv_s_s (hid_t src_id, hid_t dst_id, H5T_cdata_t *cdata, size_t nelmts, * Purpose: Convert native `float' to native `double' using hardware. * This is a fast special case. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, June 23, 1998 @@ -1610,9 +1594,7 @@ H5T_conv_float_double (hid_t __unused__ src_id, hid_t __unused__ dst_id, * Purpose: Convert native `double' to native `float' using hardware. * This is a fast special case. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, June 23, 1998 @@ -1678,9 +1660,8 @@ H5T_conv_double_float (hid_t src_id, hid_t dst_id, H5T_cdata_t *cdata, * Purpose: Converts 4-byte little-endian integers (signed or unsigned) * to 8-byte litte-endian IEEE floating point. * - * Return: Success: SUCCEED + * Return: Non-negative on success/Negative on failure * - * Failure: FAIL * * Programmer: Robb Matzke * Wednesday, June 10, 1998 @@ -28,9 +28,7 @@ static hbool_t interface_initialize_g = TRUE; * All arguments are passed by reference and their values may be * modified by this function. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Saturday, October 11, 1997 @@ -77,9 +75,7 @@ H5V_stride_optimize1(intn *np/*in,out*/, hsize_t *elmt_size/*in,out*/, * All arguments are passed by reference and their values may be * modified by this function. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Saturday, October 11, 1997 @@ -283,9 +279,7 @@ H5V_hyper_disjointp(intn n, * the minimum corner of BUF and continues for SIZE[] bytes in * each dimension. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, October 10, 1997 @@ -360,9 +354,7 @@ H5V_hyper_fill(intn n, const hsize_t *_size, * are undefined if the source hyperslab overlaps the * destination hyperslab. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Friday, October 10, 1997 @@ -464,9 +456,7 @@ H5V_hyper_copy(intn n, const hsize_t *_size, * Purpose: Fills all bytes of a hyperslab with the same value using * memset(). * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Saturday, October 11, 1997 @@ -520,9 +510,7 @@ H5V_stride_fill(intn n, hsize_t elmt_size, const hsize_t *size, * Note: If the src_stride is all zero and elmt_size is one, then it's * probably more efficient to use H5V_stride_fill() instead. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Saturday, October 11, 1997 @@ -581,9 +569,7 @@ H5V_stride_copy(int n, hsize_t elmt_size, const hsize_t *size, * we copy exactly NELMTS elements each of size ELMT_SIZE. The * size counters wrap if NELMTS is more than a size counter. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Saturday, October 11, 1997 @@ -647,9 +633,7 @@ H5V_stride_copy2(hsize_t nelmts, hsize_t elmt_size, * memset(). Increases amount copied by power of two until the * halfway point is crossed, then copies the rest in one swoop. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Quincey Koziol * Thursday, June 18, 1998 @@ -39,9 +39,7 @@ static size_t H5Z_filter_deflate(uintn flags, size_t cd_nelmts, * * Purpose: Initializes the data filter layer. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, April 16, 1998 @@ -148,9 +146,7 @@ H5Z_term_interface (void) * Purpose: This function registers new filter. The COMMENT argument is * used for debugging and may be the null pointer. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, April 16, 1998 @@ -195,9 +191,7 @@ H5Zregister(H5Z_filter_t id, const char *comment, H5Z_func_t func) * Purpose: Same as the public version except this one allows filters * to be set for predefined method numbers <256 * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Thursday, April 16, 1998 @@ -254,9 +248,7 @@ H5Z_register (H5Z_filter_t id, const char *comment, H5Z_func_t func) * * Purpose: Append another filter to the specified pipeline. * - * Return: Success: SUCCEED - * - * Failure: FAIL + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, August 4, 1998 @@ -376,9 +368,7 @@ H5Z_find(H5Z_filter_t id) * then the pipeline function should free the original buffer * and return a fresh buffer, adjusting BUF_SIZE accordingly. * - * Return: Success: 0 - * - * Failure: -1 + * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, August 4, 1998 |