PAPI  5.3.0.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
PAPI_library_init Class Reference

initialize the PAPI library. More...

Detailed Description

@param version 
    upon initialization, PAPI checks the argument against the internal 
    value of PAPI_VER_CURRENT when the library was compiled. 
    This guards against portability problems when updating the PAPI shared 
    libraries on your system. 

@retval PAPI_EINVAL 
    papi.h is different from the version used to compile the PAPI library.
@retval PAPI_ENOMEM 
    Insufficient memory to complete the operation.
@retval PAPI_ECMP 
    This component does not support the underlying hardware.
@retval PAPI_ESYS 
    A system or C library call failed inside PAPI, see the errno variable. 

PAPI_library_init() initializes the PAPI library. 
PAPI_is_initialized() check for initialization.
It must be called before any low level PAPI functions can be used. 
If your application is making use of threads PAPI_thread_init must also be 
called prior to making any calls to the library other than PAPI_library_init() . 
@par Examples:
* int retval;
* if (retval != PAPI_VER_CURRENT && retval > 0) {
* fprintf(stderr,"PAPI library version mismatch!\en");
* exit(1); }
* if (retval < 0)
* handle_error(retval);
* retval = PAPI_is_initialized();
* if (retval != PAPI_LOW_LEVEL_INITED)
* handle_error(retval)
*
Bug:
If you don't call this before using any of the low level PAPI calls, your application could core dump.
See Also
PAPI_thread_init PAPI

The documentation for this class was generated from the following file: