Synopsis

int MPI_T_cvar_read(MPI_T_cvar_handle handle, void *buf)

Input Parameters

handle

handle to the control variable to be read (handle)

Output Parameters

buf

initial address of storage location for variable value (choice)

Description

MPI_T_cvar_read queries the value of a control variable and stores the result in a user-provided buffer.

This routine has local semantics. The user must ensure that buf is of the appropriate size to hold the entire value of the control variable based on the datatype and count returned by prior calls to MPI_T_CVAR_GET_INFO and MPI_T_CVAR_HANDLE_ALLOC, respectively.

Thread and Interrupt Safety

This routine is thread-safe. This means that this routine may be safely used by multiple threads without the need for any user-provided thread locks. However, the routine is not interrupt safe. Typically, this is due to the use of memory allocation routines such as 'malloc' or other non-MPICH runtime routines that are themselves not interrupt-safe.

Errors

All MPI routines (except 'MPI_Wtime' and 'MPI_Wtick') return an error value; C routines as the value of the function and Fortran routines in the last argument. Before the value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job. The error handler may be changed with 'MPI_Comm_set_errhandler' (for communicators), 'MPI_File_set_errhandler' (for files), and 'MPI_Win_set_errhandler' (for RMA windows). The MPI-1 routine 'MPI_Errhandler_set' may be used but its use is deprecated. The predefined error handler 'MPI_ERRORS_RETURN' may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error; however, MPI implementations will attempt to continue whenever possible.

  • MPI_SUCCESS - No error; MPI routine completed successfully.

  • MPI_T_ERR_INVALID - Invalid use of the interface or bad parameter values(s).

  • MPI_T_ERR_INVALID_HANDLE - The handle is invalid.

  • MPI_T_ERR_NOT_INITIALIZED - The MPI tool information interface is not initialized.

  • MPI_ERR_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.