---
name: "PAPI_set_multiplex"
section: "3"
platform: "linux"
package: "libpapi-dev"
version: "7.1.0-5+b1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/PAPI_set_multiplex"
---

# PAPI\_set\_multiplex(3)

Convert a standard event set to a multiplexed event set.

## NAME

PAPI\_set\_multiplex - Convert a standard event set to a multiplexed event set.

## SYNOPSIS

## Detailed Description

**C Interface:**

\#include \<**papi.h**\> \
\
  int **PAPI\_set\_multiplex( int  EventSet )**;

**Parameters**

*EventSet* an integer handle for a PAPI event set as created by **PAPI\_create\_eventset**

**Return values**

*PAPI\_OK* \
 *PAPI\_EINVAL* -- One or more of the arguments is invalid, or the EventSet is already multiplexed. \
 *PAPI\_ENOCMP* -- The EventSet specified is not yet bound to a component. \
 *PAPI\_ENOEVST* -- The EventSet specified does not exist. \
 *PAPI\_EISRUN* -- The EventSet is currently counting events. \
 *PAPI\_ENOMEM* -- Insufficient memory to complete the operation.

**PAPI\_set\_multiplex** converts a standard PAPI event set created by a call to **PAPI\_create\_eventset** into an event set capable of handling multiplexed events. This must be done after calling **PAPI\_multiplex\_init**, and either **PAPI\_add\_event** or **PAPI\_assign\_eventset\_component**, but prior to calling **PAPI\_start()**.

Events can be added to an event set either before or after converting it into a multiplexed set, but the conversion must be done prior to using it as a multiplexed set.

**Note**

Multiplexing can't be enabled until PAPI knows which component is targeted. Due to the late binding nature of PAPI event sets, this only happens after adding an event to an event set or explicitly binding the component with a call to **PAPI\_assign\_eventset\_component**.

**Example:**

```
int EventSet = PAPI_NULL;
int ret;
// Create an empty EventSet
ret = PAPI_create_eventset(&EventSet);
if (ret != PAPI_OK) handle_error(ret);
// Bind it to the CPU component
ret = PAPI_assign_eventset_component(EventSet, 0);
if (ret != PAPI_OK) handle_error(ret);
// Check  current multiplex status
ret = PAPI_get_multiplex(EventSet);
if (ret == TRUE) printf("This event set is ready for multiplexing\n.")
if (ret == FALSE) printf("This event set is not enabled for multiplexing\n.")
if (ret < 0) handle_error(ret);
// Turn on multiplexing
ret = PAPI_set_multiplex(EventSet);
if ((ret == PAPI_EINVAL) && (PAPI_get_multiplex(EventSet) == TRUE))
  printf("This event set already has multiplexing enabled\n");
else if (ret != PAPI_OK) handle_error(ret);
```

**See also**

**PAPI\_multiplex\_init**

**PAPI\_get\_multiplex**

**PAPI\_set\_opt**

**PAPI\_create\_eventset**

## Author

Generated automatically by Doxygen for PAPI from the source code.