usr/src/man/man3tnf/tnfctl_strerror.3tnf

   1 '\" te
   2 .\"  Copyright (c) 1996 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 TNFCTL_STRERROR 3TNF "Mar 4, 1997"
   7 .SH NAME
   8 tnfctl_strerror \- map a tnfctl error code to a string
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-ltnfctl\fR [ \fIlibrary\fR ... ]
  13 #include <tnf/tnfctl.h>
  14
  15
  16
  17 \fBconst char *\fR \fBtnfctl_strerror\fR(\fBtnfctl_errcode_t\fR \fIerrcode\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 \fBtnfctl_strerror()\fR maps the error number in \fIerrcode\fR to an error
  24 message string, and it returns a pointer to that string. The returned string
  25 should not be overwritten or freed.
  26 .SH ERRORS
  27 .sp
  28 .LP
  29 \fBtnfctl_strerror()\fR returns the string "unknown libtnfctl.so error code" if
  30 the error number is not within the legal range.
  31 .SH ATTRIBUTES
  32 .sp
  33 .LP
  34 See \fBattributes\fR(5) for descriptions of the following attributes:
  35 .sp
  36
  37 .sp
  38 .TS
  39 box;
  40 c | c
  41 l | l .
  42 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  43 _
  44 MT Level        MT-Safe
  45 .TE
  46
  47 .SH SEE ALSO
  48 .sp
  49 .LP
  50 \fBprex\fR(1), \fBTNF_PROBE\fR(3TNF), \fBlibtnfctl\fR(3TNF),
  51 \fBtracing\fR(3TNF), \fBattributes\fR(5)