Blame man/man3/PAPI_library_init.3

Packit 577717
.TH "PAPI_library_init" 3 "Mon Dec 18 2017" "Version 5.6.0.0" "PAPI" \" -*- nroff -*-
Packit 577717
.ad l
Packit 577717
.nh
Packit 577717
.SH NAME
Packit 577717
PAPI_library_init \- 
Packit 577717
.PP
Packit 577717
initialize the PAPI library\&.  
Packit 577717
Packit 577717
.SH SYNOPSIS
Packit 577717
.br
Packit 577717
.PP
Packit 577717
.SH "Detailed Description"
Packit 577717
.PP 
Packit 577717
Packit 577717
.PP
Packit 577717
.nf
Packit 577717
@param version 
Packit 577717
    upon initialization, PAPI checks the argument against the internal 
Packit 577717
    value of PAPI_VER_CURRENT when the library was compiled. 
Packit 577717
    This guards against portability problems when updating the PAPI shared 
Packit 577717
    libraries on your system. 
Packit 577717
Packit 577717
@retval PAPI_EINVAL 
Packit 577717
    papi.h is different from the version used to compile the PAPI library.
Packit 577717
@retval PAPI_ENOMEM 
Packit 577717
    Insufficient memory to complete the operation.
Packit 577717
@retval PAPI_ECMP 
Packit 577717
    This component does not support the underlying hardware.
Packit 577717
@retval PAPI_ESYS 
Packit 577717
    A system or C library call failed inside PAPI, see the errno variable. 
Packit 577717
Packit 577717
PAPI_library_init() initializes the PAPI library. 
Packit 577717
PAPI_is_initialized() check for initialization.
Packit 577717
It must be called before any low level PAPI functions can be used. 
Packit 577717
If your application is making use of threads PAPI_thread_init must also be 
Packit 577717
called prior to making any calls to the library other than PAPI_library_init() . 
Packit 577717
@par Examples:
Packit 577717
Packit 577717
.fi
Packit 577717
.PP
Packit 577717
 
Packit 577717
.PP
Packit 577717
.nf
Packit 577717
*       int retval;
Packit 577717
*       retval = PAPI_library_init(PAPI_VER_CURRENT);
Packit 577717
*       if (retval != PAPI_VER_CURRENT && retval > 0) {
Packit 577717
*           fprintf(stderr,"PAPI library version mismatch!\en");
Packit 577717
*           exit(1); }
Packit 577717
*       if (retval < 0)
Packit 577717
*           handle_error(retval);
Packit 577717
*       retval = PAPI_is_initialized();
Packit 577717
*       if (retval != PAPI_LOW_LEVEL_INITED)
Packit 577717
*           handle_error(retval)    
Packit 577717
*   
Packit 577717
Packit 577717
.fi
Packit 577717
.PP
Packit 577717
  
Packit 577717
.PP
Packit 577717
\fBSee Also:\fP
Packit 577717
.RS 4
Packit 577717
\fBPAPI_thread_init\fP PAPI 
Packit 577717
.RE
Packit 577717
.PP
Packit 577717
Packit 577717
Packit 577717
.SH "Author"
Packit 577717
.PP 
Packit 577717
Generated automatically by Doxygen for PAPI from the source code\&.