[apple/dyld.git] / doc / man / man3 / dlerror.3

.Dd April 17, 2006
.Dt DLERROR 3
.Sh NAME
.Nm dlerror
.Nd get diagnostic information
.Sh SYNOPSIS
.In dlfcn.h
.Ft const char*
.Fn dlerror "void"
.Sh DESCRIPTION
.Fn dlerror
returns a null-terminated character string describing the last error that
occurred on this thread during a call to
.Fn dlopen ,
.Fn dlopen_preflight ,
.Fn dlsym ,
or
.Fn dlclose .
If no such error has occurred,
.Fn dlerror
returns a null pointer.
At each call to
.Fn dlerror ,
the error indication is reset.  Thus in the case of two calls
to
.Fn dlerror ,
where the second call follows the first immediately, the second call
will always return a null pointer.
.Sh SEE ALSO
.Xr dlopen 3
.Xr dlopen_preflight 3
.Xr dlclose 3
.Xr dlsym 3
.Xr dyld 3
Commit	Line	Data
bac542e6	1	.Dd April 17, 2006
0959b6d4 A	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 ,
bac542e6	15	.Fn dlopen_preflight ,
0959b6d4 A	16	.Fn dlsym ,
	17	or
	18	.Fn dlclose .
	19	If no such error has occurred,
	20	.Fn dlerror
	21	returns a null pointer.
	22	At each call to
	23	.Fn dlerror ,
	24	the error indication is reset. Thus in the case of two calls
	25	to
	26	.Fn dlerror ,
	27	where the second call follows the first immediately, the second call
	28	will always return a null pointer.
	29	.Sh SEE ALSO
	30	.Xr dlopen 3
bac542e6	31	.Xr dlopen_preflight 3
0959b6d4 A	32	.Xr dlclose 3
	33	.Xr dlsym 3
	34	.Xr dyld 3