usr/src/man/man3picl/picl_strerror.3picl

   1 '\" te
   2 .\" Copyright (c) 2000, 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 PICL_STRERROR 3PICL "Mar 28, 2000"
   7 .SH NAME
   8 picl_strerror \- get error message string
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [\fIflag \&.\|.\|.\fR] \fIfile \fR\&.\|.\|. \fB-lpicl\fR [\fIlibrary \&.\|.\|.\fR]
  13 #include <picl.h>
  14
  15 \fBchar *\fR\fBpicl_strerror\fR(\fBint\fR \fIerrnum\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBpicl_strerror()\fR function maps the error number in \fIerrnum\fR to an
  22 error message string, and returns a pointer to that string. The returned string
  23 should not be overwritten.
  24 .SH RETURN VALUES
  25 .sp
  26 .LP
  27 The \fBpicl_strerror()\fR function returns \fINULL\fR if \fIerrnum\fR is
  28 out-of-range.
  29 .SH ATTRIBUTES
  30 .sp
  31 .LP
  32 See \fBattributes\fR(5) for descriptions of the following attributes:
  33 .sp
  34
  35 .sp
  36 .TS
  37 box;
  38 c | c
  39 l | l .
  40 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  41 _
  42 MT-Level        MT-Safe
  43 .TE
  44
  45 .SH SEE ALSO
  46 .sp
  47 .LP
  48 \fBlibpicl\fR(3PICL), \fBattributes\fR(5)