share/man/man3c/dlerror.3c

   1 '\" te
   2 .\"  Copyright 1989 AT&T Copyright (c) 2004, 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 DLERROR 3C "Mar 1, 2004"
   7 .SH NAME
   8 dlerror \- get diagnostic information
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <dlfcn.h>
  13
  14 \fBchar *\fR\fBdlerror\fR(\fBvoid\fR);
  15 .fi
  16
  17 .SH DESCRIPTION
  18 .sp
  19 .LP
  20 The \fBdlerror()\fR function returns a null-terminated character string that
  21 describes the last error that occurred during dynamic linking processing. The
  22 returned string contains no trailing newline. If no dynamic linking errors have
  23 occurred since the last invocation of \fBdlerror()\fR, \fBdlerror()\fR returns
  24 \fINULL\fR. Thus, invoking  \fBdlerror()\fR a second time, immediately
  25 following a prior invocation, results in \fINULL\fR being returned.
  26 .SH USAGE
  27 .sp
  28 .LP
  29 The \fBdlerror()\fR function is one of a family of functions that give the user
  30 direct access to the dynamic linking facilities. These facilities are available
  31 to dynamically-linked processes only. See \fILinker and Libraries Guide\fR.
  32 .SH ATTRIBUTES
  33 .sp
  34 .LP
  35 See \fBattributes\fR(5) for descriptions of the following attributes:
  36 .sp
  37
  38 .sp
  39 .TS
  40 box;
  41 c | c
  42 l | l .
  43 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  44 _
  45 Interface Stability     Standard
  46 _
  47 MT-Level        MT-Safe
  48 .TE
  49
  50 .SH SEE ALSO
  51 .sp
  52 .LP
  53 \fBld\fR(1), \fBdladdr\fR(3C), \fBdlclose\fR(3C), \fBdldump\fR(3C),
  54 \fBdlopen\fR(3C), \fBdlsym\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)
  55 .sp
  56 .LP
  57 \fILinker and Libraries Guide\fR
  58 .SH NOTES
  59 .sp
  60 .LP
  61 The messages returned by  \fBdlerror()\fR can reside in a static buffer that is
  62 overwritten on each call to \fBdlerror()\fR. Application code should not write
  63 to this buffer. Programs wanting to preserve an error message should make their
  64 own copies of that message.