MPI_T_PVAR_WRITE(3)                Open MPI                MPI_T_PVAR_WRITE(3)


MPI_T_pvar_write -- Write the value of a control variable

SYNTAX
   C Syntax

          #include <mpi.h>

          int MPI_T_pvar_write(MPI_T_pvar_session session, MPI_T_pvar_handle handle, const void *buf)

INPUT PARAMETERS

       o session: Performance experiment session.

       o handle: Performance variable handle.

       o buf: Initial address of storage location for variable value.

DESCRIPTION
       MPI_T_pvar_write attempts to set the value of the performance variable
       identified by the handle specified in handle in the session specified
       in session. The value to be written is specified in buf. The caller
       must ensure that the buffer specified in buf is large enough to hold
       the entire value of the performance variable.

ERRORS
       MPI_T_pvar_write will fail if:

       o MPI_T_ERR_NOT_INITIALIZED: The MPI Tools interface not initialized

       o MPI_T_ERR_INVALID_HANDLE: The handle is invalid or not associated
         with the session

       o MPI_T_ERR_INVALID_SESSION: Session argument is not a valid session

       o MPI_T_ERR_PVAR_NO_WRITE: Variable cannot be written

       SEE ALSO:

          o MPI_T_pvar_handle_alloc

          o MPI_T_pvar_get_info

          o MPI_T_pvar_session_create

COPYRIGHT
       2003-2024, The Open MPI Community

                                 April 8, 2024             MPI_T_PVAR_WRITE(3)