usr/src/man/man3papi/papiStatusString.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 PAPISTATUSSTRING 3PAPI "Jan 17, 2007"
   7 .SH NAME
   8 papiStatusString \- return the string equivalent of a papi_status_t
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lpapi\fR [ \fIlibrary\fR\&.\|.\|. ]
  13 #include <papi.h>
  14
  15 \fBchar *\fR\fBpapiStatusString\fR(\fBpapi_status_t\fR \fIstatus\fR);
  16 .fi
  17
  18 .SH PARAMETERS
  19 .sp
  20 .ne 2
  21 .na
  22 \fB\fIstatus\fR\fR
  23 .ad
  24 .RS 10n
  25 a \fBpapi_status_t\fR returned from most \fBpapi*()\fR functions
  26 .RE
  27
  28 .SH DESCRIPTION
  29 .sp
  30 .LP
  31 The \fBpapiStatusString()\fR function takes a \fIstatus\fR value and returns a
  32 localized human-readable version of the supplied status.
  33 .SH RETURN VALUES
  34 .sp
  35 .LP
  36 The \fBpapiStatusString()\fR function always returns a text string.
  37 .SH ERRORS
  38 .sp
  39 .LP
  40 None.
  41 .SH EXAMPLES
  42 .LP
  43 \fBExample 1 \fRPrint status.
  44 .sp
  45 .in +2
  46 .nf
  47 #include <stdio.h>
  48 #include <papi.h>
  49
  50 /*ARGSUSED*/
  51 int
  52 main(int ac, char *av[])
  53 {
  54
  55     printf("status: %s\en", papiStatusString(PAPI_OK));
  56     printf("status: %s\en", papiStatusString(PAPI_DEVICE_ERROR));
  57     printf("status: %s\en", papiStatusString(PAPI_DOCUMENT_ACCESS_ERROR));
  58
  59     exit(0);
  60 }
  61 .fi
  62 .in -2
  63
  64 .SH ATTRIBUTES
  65 .sp
  66 .LP
  67 See \fBattributes\fR(5) for descriptions of the following attributes:
  68 .sp
  69
  70 .sp
  71 .TS
  72 box;
  73 c | c
  74 l | l .
  75 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  76 _
  77 Interface Stability     Volatile
  78 _
  79 MT-Level        Safe
  80 .TE
  81
  82 .SH SEE ALSO
  83 .sp
  84 .LP
  85 \fBlibpapi\fR(3LIB), \fBattributes\fR(5)