Open MPI logo

MPI_T_cvar_read(3) man page (version 5.0.0rc2)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

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 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_get_info

« Return to documentation listing