---
name: "PAPI_get_cmp_opt"
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_get_cmp_opt"
---

# PAPI\_get\_cmp\_opt(3)

Get component specific PAPI options.

## NAME

PAPI\_get\_cmp\_opt - Get component specific PAPI options.

## SYNOPSIS

## Detailed Description

**Parameters**

*option* is an input parameter describing the course of action. Possible values are defined in **papi.h** and briefly described in the table below. The Fortran calls are implementations of specific options. \
 *ptr* is a pointer to a structure that acts as both an input and output parameter. \
 *cidx* An integer identifier for a component. By convention, component 0 is always the cpu component.

**Return values**

*PAPI\_EINVAL* One or more of the arguments is invalid.

**PAPI\_get\_opt()** and **PAPI\_set\_opt()** query or change the options of the PAPI library or a specific event set created by **PAPI\_create\_eventset** . Some options may require that the eventset be bound to a component before they can execute successfully. This can be done either by adding an event or by explicitly calling **PAPI\_assign\_eventset\_component** .

The C interface for these functions passes a pointer to the **PAPI\_option\_t** structure. Not all options require or return information in this structure, and not all options are implemented for both get and set. Some options require a component index to be provided. These options are handled explicitly by the **PAPI\_get\_cmp\_opt()** call for 'get' and implicitly through the option structure for 'set'. The Fortran interface is a series of calls implementing various subsets of the C interface. Not all options in C are available in Fortran.

**Note**

Some options, such as PAPI\_DOMAIN and PAPI\_MULTIPLEX, are also available as separate entry points in both C and Fortran.

The reader is urged to see the example code in the PAPI distribution for usage of **PAPI\_get\_opt**. The file **papi.h** contains definitions for the structures unioned in the **PAPI\_option\_t** structure.

**See also**

**PAPI\_set\_debug** **PAPI\_set\_multiplex** **PAPI\_set\_domain** **PAPI\_option\_t**

## Author

Generated automatically by Doxygen for PAPI from the source code.