MPI_T_CVAR_READ(3)				     Open MPI					MPI_T_CVAR_READ(3)

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 variable.

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-handle-alloc>

	  • MPI_T_cvar_get_info <#mpi-t-cvar-get-info>

Copyright
       2003-2026, The Open MPI Community

						   Mar 05, 2026					MPI_T_CVAR_READ(3)
