xref: /illumos-gate/usr/src/man/man3papi/papiLibrarySupportedCall.3papi (revision 7ffba875a0c7cf118aef7a2c9bfd00c3935e230a)
te
Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
papiLibrarySupportedCall 3PAPI "17 Jan 2007" "SunOS 5.11" "PAPI Library Functions"
NAME
papiLibrarySupportedCall, papiLibrarySupportedCalls - determine if a PAPI function returns valid data
SYNOPSIS

cc [ flag.\|.\|. ] file.\|.\|. -lpapi [ library.\|.\|. ] 
#include <papi.h>

char papiLibrarySupportedCall(const char *name);

char **papiLibrarySupportedCalls(void);
PARAMETERS

name

the name of a PAPI function

DESCRIPTION

The papiLibrarySupportedCall() function queries to determine if a particular PAPI function returns valid data other than PAPI_OPERATION_NOT_SUPPORTED.

The papiLibrarySupportedCalls() function enumerates all PAPI functions that return valid data other than PAPI_OPERATION_NOT_SUPPORTED.

RETURN VALUES

The papiLibrarySupportedCall() function returns PAPI_TRUE if the specified PAPI function returns valid data other than PAPI_OPERATION_NOT_SUPPORTED. Otherwise, PAPI_FALSE is returned.

The papiLibrarySupportedCalls() function returns a null-terminated array of strings listing all of the PAPI functions that return valid data other than PAPI_OPERATION_NOT_SUPPORTED. Otherwise, NULL is returned.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityVolatile
MT-LevelSafe
SEE ALSO

libpapi(3LIB), attributes(5)