projects / thirdparty / man-pages.git / blame
| Commit | Line | Data |
|---|---|---|
| 75b7da85 | 1 | .\" Copyright 1995 Yggdrasil Computing, Incorporated. |
| 616c2730 | 2 | .\" and Copyright 2015 Michael Kerrisk <mtk.manpages@gmail.com> |
| 75b7da85 | 3 | .\" |
| e4a74ca8 | 4 | .\" SPDX-License-Identifier: GPL-2.0-or-later |
| 75b7da85 | 5 | .\" |
| 45186a5d | 6 | .TH DLERROR 3 2021-03-22 "Linux man-pages (unreleased)" |
| 75b7da85 MK |
7 | .SH NAME |
| 8 | dlerror \- obtain error diagnostic for functions in the dlopen API | |
| eda8a717 AC |
9 | .SH LIBRARY |
| 10 | Dynamic linking library | |
| 11 | .RI ( libdl ", " \-ldl ) | |
| 75b7da85 | 12 | .SH SYNOPSIS |
| c7db92b9 | 13 | .nf |
| 75b7da85 | 14 | .B #include <dlfcn.h> |
| 68e4db0a | 15 | .PP |
| 75b7da85 | 16 | .B "char *dlerror(void);" |
| c7db92b9 | 17 | .fi |
| 75b7da85 MK |
18 | .SH DESCRIPTION |
| 19 | The | |
| 20 | .BR dlerror () | |
| aeb4ba76 MK |
21 | function returns a human-readable, |
| 22 | null-terminated string describing the most recent error | |
| 75b7da85 MK |
23 | that occurred from a call to one of the functions in the dlopen API |
| 24 | since the last call to | |
| 25 | .BR dlerror (). | |
| c72bea43 MK |
26 | The returned string does |
| 27 | .I not | |
| 28 | include a trailing newline. | |
| 847e0d88 | 29 | .PP |
| c85226fe MK |
30 | .BR dlerror () |
| 31 | returns NULL if no errors have occurred since initialization or since | |
| 75b7da85 MK |
32 | it was last called. |
| 33 | .SH VERSIONS | |
| 34 | .BR dlerror () | |
| 35 | is present in glibc 2.0 and later. | |
| eab0df17 MK |
36 | .SH ATTRIBUTES |
| 37 | For an explanation of the terms used in this section, see | |
| 38 | .BR attributes (7). | |
| c466875e MK |
39 | .ad l |
| 40 | .nh | |
| eab0df17 MK |
41 | .TS |
| 42 | allbox; | |
| c466875e | 43 | lbx lb lb |
| eab0df17 MK |
44 | l l l. |
| 45 | Interface Attribute Value | |
| 46 | T{ | |
| 47 | .BR dlerror () | |
| 48 | T} Thread safety MT-Safe | |
| 49 | .TE | |
| c466875e MK |
50 | .hy |
| 51 | .ad | |
| 52 | .sp 1 | |
| 3113c7f3 | 53 | .SH STANDARDS |
| 75b7da85 MK |
54 | POSIX.1-2001. |
| 55 | .SH NOTES | |
| 78978ec9 MK |
56 | The message returned by |
| 57 | .BR dlerror () | |
| ccbdce6e | 58 | may reside in a statically allocated buffer that is |
| 78978ec9 MK |
59 | overwritten by subsequent |
| 60 | .BR dlerror () | |
| 61 | calls. | |
| 75b7da85 MK |
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. | |
| a14af333 | 73 | .SH EXAMPLES |
| 75b7da85 MK |
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) |