usr/src/man/man3papi/papiLibrarySupportedCall.3papi

   1 '\" te
   2 .\" Copyright (c) 2007, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH PAPILIBRARYSUPPORTEDCALL 3PAPI "Jan 17, 2007"
   7 .SH NAME
   8 papiLibrarySupportedCall, papiLibrarySupportedCalls \- determine if a PAPI
   9 function returns valid data
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lpapi\fR [ \fIlibrary\fR\&.\|.\|. ]
  14 #include <papi.h>
  15
  16 \fBchar\fR \fBpapiLibrarySupportedCall\fR(\fBconst char *\fR\fIname\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBchar **\fR\fBpapiLibrarySupportedCalls\fR(\fBvoid\fR);
  22 .fi
  23
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fIname\fR\fR
  29 .ad
  30 .RS 8n
  31 the name of a PAPI function
  32 .RE
  33
  34 .SH DESCRIPTION
  35 .sp
  36 .LP
  37 The \fBpapiLibrarySupportedCall()\fR function queries to determine if a
  38 particular PAPI function returns valid data other than
  39 \fBPAPI_OPERATION_NOT_SUPPORTED\fR.
  40 .sp
  41 .LP
  42 The \fBpapiLibrarySupportedCalls()\fR function enumerates all PAPI functions
  43 that return valid data other than \fBPAPI_OPERATION_NOT_SUPPORTED\fR.
  44 .SH RETURN VALUES
  45 .sp
  46 .LP
  47 The \fBpapiLibrarySupportedCall()\fR function returns \fBPAPI_TRUE\fR if the
  48 specified PAPI function returns valid data other than
  49 \fBPAPI_OPERATION_NOT_SUPPORTED\fR.  Otherwise, \fBPAPI_FALSE\fR is returned.
  50 .sp
  51 .LP
  52 The \fBpapiLibrarySupportedCalls()\fR function returns a null-terminated array
  53 of strings listing all of the PAPI functions that return valid data other than
  54 \fBPAPI_OPERATION_NOT_SUPPORTED\fR. Otherwise, \fINULL\fR is returned.
  55 .SH ATTRIBUTES
  56 .sp
  57 .LP
  58 See \fBattributes\fR(5) for descriptions of the following attributes:
  59 .sp
  60
  61 .sp
  62 .TS
  63 box;
  64 c | c
  65 l | l .
  66 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  67 _
  68 Interface Stability     Volatile
  69 _
  70 MT-Level        Safe
  71 .TE
  72
  73 .SH SEE ALSO
  74 .sp
  75 .LP
  76 \fBlibpapi\fR(3LIB), \fBattributes\fR(5)