dyld-43.tar.gz
[apple/dyld.git] / doc / man / man3 / dlerror.3
1 .Dd Sept 25, 2004
2 .Dt DLERROR 3
3 .Sh NAME
4 .Nm dlerror
5 .Nd get diagnostic information
6 .Sh SYNOPSIS
7 .In dlfcn.h
8 .Ft const char*
9 .Fn dlerror "void"
10 .Sh DESCRIPTION
11 .Fn dlerror
12 returns a null-terminated character string describing the last error that
13 occurred on this thread during a call to
14 .Fn dlopen ,
15 .Fn dlsym ,
16 or
17 .Fn dlclose .
18 If no such error has occurred,
19 .Fn dlerror
20 returns a null pointer.
21 At each call to
22 .Fn dlerror ,
23 the error indication is reset.  Thus in the case of two calls
24 to
25 .Fn dlerror ,
26 where the second call follows the first immediately, the second call
27 will always return a null pointer.
28 .Sh SEE ALSO
29 .Xr dlopen 3
30 .Xr dlclose 3
31 .Xr dlsym 3
32 .Xr dyld 3