NAME
dlclose — close a
dlopen object
SYNOPSIS
int dlclose(void *handle);
DESCRIPTION
The dlclose () function shall inform the
system that the object referenced by a handle returned
from a previous dlopen(3) invocation is no longer needed
by the application.
The use of dlclose () reflects a statement
of intent on the part of the process, but does not create any requirement
upon the implementation, such as removal of the code or symbols referenced
by handle. Once an object has been closed using
dlclose () an application should assume that its
symbols are no longer available to dlsym(3). All objects
loaded automatically as a result of invoking dlopen(3) on
the referenced object shall also be closed if this is the last reference to
it.
Although a dlclose () operation is not
required to remove structures from an address space, neither is an
implementation prohibited from doing so. The only restriction on such a
removal is that no object shall be removed to which references have been
relocated, until or unless all such references are removed. For instance, an
object that had been loaded with a dlopen(3) operation
specifying the RTLD_GLOBAL flag might provide a target for dynamic
relocations performed in the processing of other objects-in such
environments, an application may assume that no relocation, once made, shall
be undone or remade unless the object requiring the relocation has itself
been removed.
RETURN VALUE
If the referenced object was successfully closed,
dlclose () shall return 0. If the object could not
be closed, or if handle does not refer to an open object,
dlclose () shall return a non-zero value. More
detailed diagnostic information shall be available through
dlerror(3).
ERRORS
No errors are defined.
EXAMPLES
The following example illustrates use of
dlopen(3) and dlclose ():
...
/* Open a dynamic library and then close it ... */
#include <dlfcn.h>
void *mylib;
int eret;
mylib = dlopen("mylib.so", RTLD_LOCAL | RTLD_LAZY);
...
eret = dlclose(mylib);
...
APPLICATION USAGE
A conforming application should employ a handle
returned from a dlopen(3) invocation only within a given
scope bracketed by the dlopen(3) and
dlclose () operations. Implementations are free to
use reference counting or other techniques such that multiple calls to
dlopen(3) referencing the same object may return the same
object for handle. Implementations are also free to reuse
a handle. For these reasons, the value of a
handle must be treated as an opaque object by the
application, used only in calls to dlsym(3) and
dlclose ().
RATIONALE
None.
FUTURE DIRECTIONS
None.
SEE ALSO
dlerror(3) , dlopen(3) , dlsym(3) , the Base Definitions volume of IEEE Std 1003.1-2001 (“POSIX.1”), <dlfcn.h>
CHANGE HISTORY
First released in Issue 5.
Issue 6
The DESCRIPTION is updated to say that the referenced object is closed "if this is the last reference to it".
End of informative text. footer end