xref: /dflybsd-src/lib/libc/gen/dlerror.3 (revision 86d7f5d305c6adaa56ff4582ece9859d73106103)
1*86d7f5d3SJohn Marino.\" This source code is a product of Sun Microsystems, Inc. and is provided
2*86d7f5d3SJohn Marino.\" for unrestricted use provided that this legend is included on all tape
3*86d7f5d3SJohn Marino.\" media and as a part of the software program in whole or part.  Users
4*86d7f5d3SJohn Marino.\" may copy or modify this source code without charge, but are not authorized
5*86d7f5d3SJohn Marino.\" to license or distribute it to anyone else except as part of a product or
6*86d7f5d3SJohn Marino.\" program developed by the user.
7*86d7f5d3SJohn Marino.\"
8*86d7f5d3SJohn Marino.\" THIS PROGRAM CONTAINS SOURCE CODE COPYRIGHTED BY SUN MICROSYSTEMS, INC.
9*86d7f5d3SJohn Marino.\" SUN MICROSYSTEMS, INC., MAKES NO REPRESENTATIONS ABOUT THE SUITABLITY
10*86d7f5d3SJohn Marino.\" OF SUCH SOURCE CODE FOR ANY PURPOSE.  IT IS PROVIDED "AS IS" WITHOUT
11*86d7f5d3SJohn Marino.\" EXPRESS OR IMPLIED WARRANTY OF ANY KIND.  SUN MICROSYSTEMS, INC. DISCLAIMS
12*86d7f5d3SJohn Marino.\" ALL WARRANTIES WITH REGARD TO SUCH SOURCE CODE, INCLUDING ALL IMPLIED
13*86d7f5d3SJohn Marino.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  IN
14*86d7f5d3SJohn Marino.\" NO EVENT SHALL SUN MICROSYSTEMS, INC. BE LIABLE FOR ANY SPECIAL, INDIRECT,
15*86d7f5d3SJohn Marino.\" INCIDENTAL, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
16*86d7f5d3SJohn Marino.\" FROM USE OF SUCH SOURCE CODE, REGARDLESS OF THE THEORY OF LIABILITY.
17*86d7f5d3SJohn Marino.\"
18*86d7f5d3SJohn Marino.\" This source code is provided with no support and without any obligation on
19*86d7f5d3SJohn Marino.\" the part of Sun Microsystems, Inc. to assist in its use, correction,
20*86d7f5d3SJohn Marino.\" modification or enhancement.
21*86d7f5d3SJohn Marino.\"
22*86d7f5d3SJohn Marino.\" SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
23*86d7f5d3SJohn Marino.\" INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY THIS
24*86d7f5d3SJohn Marino.\" SOURCE CODE OR ANY PART THEREOF.
25*86d7f5d3SJohn Marino.\"
26*86d7f5d3SJohn Marino.\" Sun Microsystems, Inc.
27*86d7f5d3SJohn Marino.\" 2550 Garcia Avenue
28*86d7f5d3SJohn Marino.\" Mountain View, California 94043
29*86d7f5d3SJohn Marino.\"
30*86d7f5d3SJohn Marino.\" Copyright (c) 1991 Sun Microsystems, Inc.
31*86d7f5d3SJohn Marino.\"
32*86d7f5d3SJohn Marino.\" $FreeBSD: release/8.1.0/lib/libc/gen/dlopen.3 205979 2010-03-31 13:51:31Z gahr $
33*86d7f5d3SJohn Marino.\"
34*86d7f5d3SJohn Marino.Dd April 28, 2011
35*86d7f5d3SJohn Marino.Dt DLERROR 3
36*86d7f5d3SJohn Marino.Os
37*86d7f5d3SJohn Marino.Sh NAME
38*86d7f5d3SJohn Marino.Nm dlerror
39*86d7f5d3SJohn Marino.Nd retrieve dynamic linker error messages
40*86d7f5d3SJohn Marino.Sh LIBRARY
41*86d7f5d3SJohn MarinoThis function is not in a library.
42*86d7f5d3SJohn MarinoIt is included in every dynamically linked program automatically.
43*86d7f5d3SJohn Marino.Sh SYNOPSIS
44*86d7f5d3SJohn Marino.In dlfcn.h
45*86d7f5d3SJohn Marino.Ft char *
46*86d7f5d3SJohn Marino.Fn dlerror "void"
47*86d7f5d3SJohn Marino.Sh DESCRIPTION
48*86d7f5d3SJohn MarinoThe
49*86d7f5d3SJohn Marino.Fn dlerror
50*86d7f5d3SJohn Marinofunction
51*86d7f5d3SJohn Marinoreturns a null-terminated character string describing the last error that
52*86d7f5d3SJohn Marinooccurred during a call to
53*86d7f5d3SJohn Marino.Fn dlopen ,
54*86d7f5d3SJohn Marino.Fn dladdr ,
55*86d7f5d3SJohn Marino.Fn dlinfo ,
56*86d7f5d3SJohn Marino.Fn dlsym ,
57*86d7f5d3SJohn Marino.Fn dlvsym ,
58*86d7f5d3SJohn Marinoor
59*86d7f5d3SJohn Marino.Fn dlclose .
60*86d7f5d3SJohn MarinoIf no such error has occurred,
61*86d7f5d3SJohn Marino.Fn dlerror
62*86d7f5d3SJohn Marinoreturns a null pointer.
63*86d7f5d3SJohn MarinoAt each call to
64*86d7f5d3SJohn Marino.Fn dlerror ,
65*86d7f5d3SJohn Marinothe error indication is reset.
66*86d7f5d3SJohn MarinoThus in the case of two calls
67*86d7f5d3SJohn Marinoto
68*86d7f5d3SJohn Marino.Fn dlerror ,
69*86d7f5d3SJohn Marinowhere the second call follows the first immediately, the second call
70*86d7f5d3SJohn Marinowill always return a null pointer.
71*86d7f5d3SJohn Marino.Sh SEE ALSO
72*86d7f5d3SJohn Marino.Xr rtld 1 ,
73*86d7f5d3SJohn Marino.Xr dlclose 3 ,
74*86d7f5d3SJohn Marino.Xr dlfcn 3 ,
75*86d7f5d3SJohn Marino.Xr dlopen 3 ,
76*86d7f5d3SJohn Marino.Xr dlsym 3 ,
77*86d7f5d3SJohn Marino.Xr dlvsym 3
78