man3/dlerror.3

   1 .\" Copyright 1995 Yggdrasil Computing, Incorporated.
   2 .\" and Copyright 2015 Michael Kerrisk <mtk.manpages@gmail.com>
   3 .\"
   4 .\" SPDX-License-Identifier: GPL-2.0-or-later
   5 .\"
   6 .TH DLERROR 3 2021-03-22 "Linux man-pages (unreleased)"
   7 .SH NAME
   8 dlerror \- obtain error diagnostic for functions in the dlopen API
   9 .SH LIBRARY
  10 Dynamic linking library
  11 .RI ( libdl ", " \-ldl )
  12 .SH SYNOPSIS
  13 .nf
  14 .B #include <dlfcn.h>
  15 .PP
  16 .B "char *dlerror(void);"
  17 .fi
  18 .SH DESCRIPTION
  19 The
  20 .BR dlerror ()
  21 function returns a human-readable,
  22 null-terminated string describing the most recent error
  23 that occurred from a call to one of the functions in the dlopen API
  24 since the last call to
  25 .BR dlerror ().
  26 The returned string does
  27 .I not
  28 include a trailing newline.
  29 .PP
  30 .BR dlerror ()
  31 returns NULL if no errors have occurred since initialization or since
  32 it was last called.
  33 .SH VERSIONS
  34 .BR dlerror ()
  35 is present in glibc 2.0 and later.
  36 .SH ATTRIBUTES
  37 For an explanation of the terms used in this section, see
  38 .BR attributes (7).
  39 .ad l
  40 .nh
  41 .TS
  42 allbox;
  43 lbx lb lb
  44 l l l.
  45 Interface       Attribute       Value
  46 T{
  47 .BR dlerror ()
  48 T}      Thread safety   MT-Safe
  49 .TE
  50 .hy
  51 .ad
  52 .sp 1
  53 .SH STANDARDS
  54 POSIX.1-2001.
  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 .\" .LP
  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 .SS History
  72 This function is part of the dlopen API, derived from SunOS.
  73 .SH EXAMPLES
  74 See
  75 .BR dlopen (3).
  76 .SH SEE ALSO
  77 .BR dladdr (3),
  78 .BR dlinfo (3),
  79 .BR dlopen (3),
  80 .BR dlsym (3)