dwww Home | Manual pages | Find package

MPI_T_cvar_read(3)                 Open MPI                 MPI_T_cvar_read(3)

NAME
       MPI_T_cvar_read - Read the value of a control variable

SYNTAX
C Syntax
       #include <mpi.h>
       int MPI_T_cvar_read(MPI_T_cvar_handle handle, const void *buf)

INPUT PARAMETERS
       handle    Handle of the control variable to be read.

       buf       Initial address of storage location for variable value.

DESCRIPTION
       MPI_T_cvar_read  reads  the value of the control variable identified by
       the handle specified in handle and  stores  the  value  in  the  buffer
       pointed  to  by buf.  The caller must ensure that the buffer pointed to
       by buf is large enough to hold the entire value of  the  control  vari-
       able.

ERRORS
       MPI_T_cvar_read() will fail if:

       [MPI_T_ERR_NOT_INITIALIZED]
                 The MPI Tools interface not initialized

       [MPI_T_ERR_INVALID_HANDLE]
                 The handle is invalid

SEE ALSO
       MPI_T_cvar_handle_alloc
       MPI_T_cvar_get_info

4.1.2                            Nov 24, 2021               MPI_T_cvar_read(3)

Generated by dwww version 1.14 on Mon Jan 27 11:20:21 CET 2025.