xref: /dflybsd-src/lib/libc/gen/dlerror.3 (revision 86d7f5d305c6adaa56ff4582ece9859d73106103)
186d7f5d3SJohn Marino.\" This source code is a product of Sun Microsystems, Inc. and is provided
286d7f5d3SJohn Marino.\" for unrestricted use provided that this legend is included on all tape
386d7f5d3SJohn Marino.\" media and as a part of the software program in whole or part.  Users
486d7f5d3SJohn Marino.\" may copy or modify this source code without charge, but are not authorized
586d7f5d3SJohn Marino.\" to license or distribute it to anyone else except as part of a product or
686d7f5d3SJohn Marino.\" program developed by the user.
786d7f5d3SJohn Marino.\"
886d7f5d3SJohn Marino.\" THIS PROGRAM CONTAINS SOURCE CODE COPYRIGHTED BY SUN MICROSYSTEMS, INC.
986d7f5d3SJohn Marino.\" SUN MICROSYSTEMS, INC., MAKES NO REPRESENTATIONS ABOUT THE SUITABLITY
1086d7f5d3SJohn Marino.\" OF SUCH SOURCE CODE FOR ANY PURPOSE.  IT IS PROVIDED "AS IS" WITHOUT
1186d7f5d3SJohn Marino.\" EXPRESS OR IMPLIED WARRANTY OF ANY KIND.  SUN MICROSYSTEMS, INC. DISCLAIMS
1286d7f5d3SJohn Marino.\" ALL WARRANTIES WITH REGARD TO SUCH SOURCE CODE, INCLUDING ALL IMPLIED
1386d7f5d3SJohn Marino.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  IN
1486d7f5d3SJohn Marino.\" NO EVENT SHALL SUN MICROSYSTEMS, INC. BE LIABLE FOR ANY SPECIAL, INDIRECT,
1586d7f5d3SJohn Marino.\" INCIDENTAL, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
1686d7f5d3SJohn Marino.\" FROM USE OF SUCH SOURCE CODE, REGARDLESS OF THE THEORY OF LIABILITY.
1786d7f5d3SJohn Marino.\"
1886d7f5d3SJohn Marino.\" This source code is provided with no support and without any obligation on
1986d7f5d3SJohn Marino.\" the part of Sun Microsystems, Inc. to assist in its use, correction,
2086d7f5d3SJohn Marino.\" modification or enhancement.
2186d7f5d3SJohn Marino.\"
2286d7f5d3SJohn Marino.\" SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
2386d7f5d3SJohn Marino.\" INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY THIS
2486d7f5d3SJohn Marino.\" SOURCE CODE OR ANY PART THEREOF.
2586d7f5d3SJohn Marino.\"
2686d7f5d3SJohn Marino.\" Sun Microsystems, Inc.
2786d7f5d3SJohn Marino.\" 2550 Garcia Avenue
2886d7f5d3SJohn Marino.\" Mountain View, California 94043
2986d7f5d3SJohn Marino.\"
3086d7f5d3SJohn Marino.\" Copyright (c) 1991 Sun Microsystems, Inc.
3186d7f5d3SJohn Marino.\"
3286d7f5d3SJohn Marino.\" $FreeBSD: release/8.1.0/lib/libc/gen/dlopen.3 205979 2010-03-31 13:51:31Z gahr $
3386d7f5d3SJohn Marino.\"
3486d7f5d3SJohn Marino.Dd April 28, 2011
3586d7f5d3SJohn Marino.Dt DLERROR 3
3686d7f5d3SJohn Marino.Os
3786d7f5d3SJohn Marino.Sh NAME
3886d7f5d3SJohn Marino.Nm dlerror
3986d7f5d3SJohn Marino.Nd retrieve dynamic linker error messages
4086d7f5d3SJohn Marino.Sh LIBRARY
4186d7f5d3SJohn MarinoThis function is not in a library.
4286d7f5d3SJohn MarinoIt is included in every dynamically linked program automatically.
4386d7f5d3SJohn Marino.Sh SYNOPSIS
4486d7f5d3SJohn Marino.In dlfcn.h
4586d7f5d3SJohn Marino.Ft char *
4686d7f5d3SJohn Marino.Fn dlerror "void"
4786d7f5d3SJohn Marino.Sh DESCRIPTION
4886d7f5d3SJohn MarinoThe
4986d7f5d3SJohn Marino.Fn dlerror
5086d7f5d3SJohn Marinofunction
5186d7f5d3SJohn Marinoreturns a null-terminated character string describing the last error that
5286d7f5d3SJohn Marinooccurred during a call to
5386d7f5d3SJohn Marino.Fn dlopen ,
5486d7f5d3SJohn Marino.Fn dladdr ,
5586d7f5d3SJohn Marino.Fn dlinfo ,
5686d7f5d3SJohn Marino.Fn dlsym ,
5786d7f5d3SJohn Marino.Fn dlvsym ,
5886d7f5d3SJohn Marinoor
5986d7f5d3SJohn Marino.Fn dlclose .
6086d7f5d3SJohn MarinoIf no such error has occurred,
6186d7f5d3SJohn Marino.Fn dlerror
6286d7f5d3SJohn Marinoreturns a null pointer.
6386d7f5d3SJohn MarinoAt each call to
6486d7f5d3SJohn Marino.Fn dlerror ,
6586d7f5d3SJohn Marinothe error indication is reset.
6686d7f5d3SJohn MarinoThus in the case of two calls
6786d7f5d3SJohn Marinoto
6886d7f5d3SJohn Marino.Fn dlerror ,
6986d7f5d3SJohn Marinowhere the second call follows the first immediately, the second call
7086d7f5d3SJohn Marinowill always return a null pointer.
7186d7f5d3SJohn Marino.Sh SEE ALSO
7286d7f5d3SJohn Marino.Xr rtld 1 ,
7386d7f5d3SJohn Marino.Xr dlclose 3 ,
7486d7f5d3SJohn Marino.Xr dlfcn 3 ,
7586d7f5d3SJohn Marino.Xr dlopen 3 ,
7686d7f5d3SJohn Marino.Xr dlsym 3 ,
7786d7f5d3SJohn Marino.Xr dlvsym 3
78