---
name: "MPI_T_pvar_write"
section: "3"
platform: "linux"
package: "openmpi"
version: "5.0.11-1"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/MPI_T_pvar_write"
---

# MPI\_T\_pvar\_write(3)

*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

- •

  **session**: Performance experiment session.

- •

  **handle**: Performance variable handle.

- •

  **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:

- •

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

- •

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

## COPYRIGHT

2003-2026, The Open MPI Community