summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorAlbert Cheng <acheng@hdfgroup.org>1998-02-13 15:32:32 (GMT)
committerAlbert Cheng <acheng@hdfgroup.org>1998-02-13 15:32:32 (GMT)
commitedbd6152fde9f376360ce07af51b50a3e026327f (patch)
treee0c2ae7b02534473354cfe93930516f60b80cb39 /src
parent7cfd4f3872953ed92c25fa3079c4f9a26111f94b (diff)
downloadhdf5-edbd6152fde9f376360ce07af51b50a3e026327f.zip
hdf5-edbd6152fde9f376360ce07af51b50a3e026327f.tar.gz
hdf5-edbd6152fde9f376360ce07af51b50a3e026327f.tar.bz2
[svn-r268] Revised the comment block of H5Cset_mpi. Also fixed a small bug in
the same function in the call of MPI_Comm_dup.
Diffstat (limited to 'src')
-rw-r--r--src/H5C.c37
1 files changed, 33 insertions, 4 deletions
diff --git a/src/H5C.c b/src/H5C.c
index 7a20114..07e94dd 100644
--- a/src/H5C.c
+++ b/src/H5C.c
@@ -862,9 +862,38 @@ H5Cget_chunk(hid_t tid, int max_ndims, size_t dim[] /*out */ )
/*-------------------------------------------------------------------------
* Function: H5Cset_mpi
*
- * Purpose: Sets the access mode for MPIO call and store the user supplied
- * communicator and info.
- *
+ * Signature: herr_t H5Cset_mpi(hid_t tid, MPI_Comm comm, MPI_Info info,
+ * uintn access_mode)
+ *
+ * Purpose: Store the access mode for MPIO call and the user supplied
+ * communicator and info in the access template which can then
+ * be used to open file. This function is available only in the
+ * parallel HDF5 library and is not a collective function.
+ *
+ * Parameters:
+ * hid_t tid
+ * ID of template to modify
+ * MPI_Comm comm
+ * MPI communicator to be used for file open as defined in
+ * MPI_FILE_OPEN of MPI-2. This function does not make a
+ * duplicated communicator. Any modification to comm after
+ * this function call returns may have undetermined effect
+ * to the access template. Users should call this function
+ * again to setup the template.
+ * MPI_Info info
+ * MPI info object to be used for file open as defined in
+ * MPI_FILE_OPEN of MPI-2. This function does not make a
+ * duplicated info. Any modification to info after
+ * this function call returns may have undetermined effect
+ * to the access template. Users should call this function
+ * again to setup the template.
+ * uintn access_mode
+ * File data access modes:
+ * H5ACC_INDEPENDENT
+ * Allow independent datasets access.
+ * H5ACC_COLLECTIVE
+ * Allow only collective datasets access.
+ *
* Return: Success: SUCCEED
*
* Failure: FAIL
@@ -910,7 +939,7 @@ H5Cset_mpi (hid_t tid, MPI_Comm comm, MPI_Info info, uintn access_mode)
/* need to verify comm and info contain sensible information */
/* need to duplicate info too but don't know a quick way to do it now. */
#endif
- if ((mrc = MPI_Comm_dup(comm, &lcomm) != MPI_SUCCESS))
+ if ((mrc = MPI_Comm_dup(comm, &lcomm)) != MPI_SUCCESS)
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"failure to duplicate communicator");
tmpl->comm = comm;