man3/dlerror.3

   1 '\" t
   2 .\" Copyright 1995 Yggdrasil Computing, Incorporated.
   3 .\" and Copyright 2015 Michael Kerrisk <mtk.manpages@gmail.com>
   4 .\"
   5 .\" SPDX-License-Identifier: GPL-2.0-or-later
   6 .\"
   7 .TH dlerror 3 (date) "Linux man-pages (unreleased)"
   8 .SH NAME
   9 dlerror \- obtain error diagnostic for functions in the dlopen API
  10 .SH LIBRARY
  11 Dynamic linking library
  12 .RI ( libdl ", " \-ldl )
  13 .SH SYNOPSIS
  14 .nf
  15 .B #include <dlfcn.h>
  16 .P
  17 .B "char *dlerror(void);"
  18 .fi
  19 .SH DESCRIPTION
  20 The
  21 .BR dlerror ()
  22 function returns a human-readable,
  23 null-terminated string describing the most recent error
  24 that occurred from a call to one of the functions in the dlopen API
  25 since the last call to
  26 .BR dlerror ().
  27 The returned string does
  28 .I not
  29 include a trailing newline.
  30 .P
  31 .BR dlerror ()
  32 returns NULL if no errors have occurred since initialization or since
  33 it was last called.
  34 .SH ATTRIBUTES
  35 For an explanation of the terms used in this section, see
  36 .BR attributes (7).
  37 .TS
  38 allbox;
  39 lbx lb lb
  40 l l l.
  41 Interface       Attribute       Value
  42 T{
  43 .na
  44 .nh
  45 .BR dlerror ()
  46 T}      Thread safety   MT-Safe
  47 .TE
  48 .SH STANDARDS
  49 POSIX.1-2008.
  50 .SH HISTORY
  51 glibc 2.0.
  52 POSIX.1-2001.
  53 .P
  54 SunOS.
  55 .SH NOTES
  56 The message returned by
  57 .BR dlerror ()
  58 may reside in a statically allocated buffer that is
  59 overwritten by subsequent
  60 .BR dlerror ()
  61 calls.
  62 .\" .P
  63 .\" The string returned by
  64 .\" .BR dlerror ()
  65 .\" should not be modified.
  66 .\" Some systems give the prototype as
  67 .\" .sp
  68 .\" .in +5
  69 .\" .B "const char *dlerror(void);"
  70 .\" .in
  71 .SH EXAMPLES
  72 See
  73 .BR dlopen (3).
  74 .SH SEE ALSO
  75 .BR dladdr (3),
  76 .BR dlinfo (3),
  77 .BR dlopen (3),
  78 .BR dlsym (3)