-*- nroff -*-
 Copyright 2013 Los Alamos National Security, LLC. All rights reserved.
 Copyright 2006-2008 Sun Microsystems, Inc.
 Copyright (c) 1996 Thinking Machines Corporation
 Copyright (c) 2010 Cisco Systems, Inc. All rights reserved.
 $COPYRIGHT$
 MPI_T_pvar_write 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
.

 NAME
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
 1i
session
Performance experiment session.

 1i
handle
Performance variable handle.

 1i
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:

 1i
[MPI_T_ERR_NOT_INITIALIZED]
The MPI Tools interface not initialized

 1i
[MPI_T_ERR_INVALID_HANDLE]
The handle is invalid or not associated with the session

 1i
[MPI_T_ERR_INVALID_SESSION]
Session argument is not a valid session

 1i
[MPI_T_ERR_PVAR_NO_WRITE]
Variable cannot be written


 SEE ALSO
MPI_T_pvar_handle_alloc
MPI_T_pvar_get_info
MPI_T_pvar_session_create