MPI_T_PVAR_READ(3)				     Open MPI					MPI_T_PVAR_READ(3)

MPI_T_pvar_read — Read the value of a performance variable

SYNTAX
   C Syntax
	  #include <mpi.h>

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

INPUT PARAMETERS
       • session: Performance experiment session.

       • handle: Performance variable handle.

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

DESCRIPTION
       MPI_T_pvar_read queries the value of a performance variable identified by the handle specified in handle in
       the  session  specified	in  session. The result is stored 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  performance
       variable.

ERRORS
       MPI_T_pvar_read will fail if:

       • MPI_T_ERR_NOT_INITIALIZED: The MPI Tools interface not initialized

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

       • MPI_T_ERR_INVALID_SESSION: Session argument is not a valid session

       See also:

	  • MPI_T_pvar_handle_alloc <#mpi-t-pvar-handle-alloc>

	  • MPI_T_pvar_get_info <#mpi-t-pvar-get-info>

	  • MPI_T_pvar_session_create <#mpi-t-pvar-session-create>

Copyright
       2003-2026, The Open MPI Community

						   Mar 05, 2026					MPI_T_PVAR_READ(3)
