PAPI return codes

The following return codes may be returned from PAPI functions.

Table 1. PAPI function return codes
Return Code	Value	Description
PAPI_OK	0	Success.
PAPI_HELPER_RETURN_NULL	NULL	NULL return from PAPI helper function.
PAPI_HELPER_RETURN_ZERO	0	Zero return from PAPI helper function.
PAPI_NOK	1	Generic error.
PAPI_INVALID_PARAMETER_VALUE	2	Parameter has an invalid value.
PAPI_CLIENT_ALREADY_INITIALIZED	4	User already issued papi_connect().
PAPI_CLIENT_ALREADY_REGISTERED	5	User already issued papi_connect().
PAPI_FUNC_NOT_READY	8	PAPI function not ready - try again later.
PAPI_INVALID_ACCEPTABLE_CACHED_TIME	10	The acceptableCachedTime input parameter is ignored because it is less than the MinimimSamplingInterval configured to the Policy Agent.
PAPI_ PERF_COLL_TYPE_MISMATCH	11	Some or all of the requested type of performance data (rules, actions, or both) is not being collected by the Policy Agent.
PAPI_MALLOC_FAILED	16	PAPI could not allocate memory in user's address space.
PAPI_MALLOC_IN_PAGENT_FAILED	17	Policy Agent could not allocate memory.
PAPI_PAGENT_INTERNAL_ERROR	18	Internal error encountered in Policy Agent.
PAPI_INTERNAL_ERROR	19	Internal error encountered in PAPI.
PAPI_CLIENT_NOT_REGISTERED	20	User did not issue papi_connect().
PAPI_NOT_VALID_AUTHORIZATION	21	User not authorized to issue PAPI function.
PAPI_VERSION_INCORRECT	22	Incompatibility between the version of the PAPI DLL (papi.dll) and the version of Policy Agent.
PAPI_CONNECT_FAILED	30	Connect to Policy Agent failed.
PAPI_READ_FAILED	31	Read from Policy Agent failed.
PAPI_SOCKET_NOT_READABLE	32	Socket for Policy Agent connection is not readable.
PAPI_WRITE_FAILED	33	Write to Policy Agent failed.
PAPI_READ_TIMEOUT	34	Read from Policy Agent timed out.
PAPI_SOCKET_FAILED	35	Could not open socket for Policy Agent connection.
PAPI_FCNTL_FAILED	36	fcntl() on connection socket failed.
PAPI_NULL_INPUT	50	A required parameter is not specified.
PAPI_TCPIMAGE_NOT_VALID	51	The specified kernel name is not known to the Policy Agent.
PAPI_TCPIMAGE_INVALID_LENGTH	52	The specified kernel name is too long.
PAPI_FILTERNAME_INVALID_LENGTH	53	The specified filter name is too long.
PAPI_KERNEL_NOT_AVAILABLE	54	The TCP/IP stack is not available to process a request, or an error occurred while obtaining data from the stack.