Open MPI logo

MPI_T_pvar_handle_alloc(3) man page (version 3.0.6)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

MPI_T_pvar_handle_alloc, MPI_T_pvar_handle_free - Allocate/free MPI performance variable handles

Syntax

C Syntax


#include <mpi.h>
int MPI_T_pvar_handle_alloc(int pvar_index, void *obj_handle,
                            MPI_T_pvar_handle *handle, int *count)
int MPI_T_pvar_handle_free(MPI_T_pvar_handle *handle)
DescriptionMPI_T_pvar_handle_alloc binds the performance variable specified
in pvar_index to the MPI object specified in obj_handle. If MPI_T_pvar_get_info
returns MPI_T_BIND_NO_OBJECT as the binding for the variable the obj_handle
argument is ignored. The number of values represented by this performance
variable is returned in the count parameter.  MPI_T_pvar_handle_free frees
a handle allocated by MPI_T_pvar_handle_alloc and sets the handle argument
to MPI_T_PVAR_HANDLE_NULL.   ErrorsMPI_T_pvar_handle_alloc() will fail if:
[MPI_T_ERR_NOT_INITIALIZED] The MPI Tools interface not initialized [MPI_T_ERR_INVALID_INDEX]
The performance variable index is invalid [MPI_T_ERR_OUT_OF_HANDLES] No
more handles available MPI_T_pvar_handle_free() 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_pvar_get_info

« Return to documentation listing