diff dynload/dynload.3 @ 0:3e629dc19168

initial from svn dyncall-1745
author Daniel Adler
date Thu, 19 Mar 2015 22:24:28 +0100
parents
children c40e9fcccc41
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/dynload/dynload.3	Thu Mar 19 22:24:28 2015 +0100
@@ -0,0 +1,64 @@
+.\" Copyright (c) 2007-2014 Daniel Adler <dadler AT uni-goettingen DOT de>, 
+.\"                         Tassilo Philipp <tphilipp AT potion-studios DOT com>
+.\" 
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd $Mdocdate$
+.Dt dynload 3
+.Os
+
+.Sh NAME
+.Nm dynload
+.Nd encapsulates dynamic loading mechanisms and
+gives access to functions in foreign dynamic libraries and code modules.
+.Sh SYNOPSIS
+.In dynload.h
+.Ft DLLib *
+.Fn dlLoadLibrary "const char * libpath"
+.Ft void
+.Fn dlFreeLibrary "DLLib * pLib"
+.Ft void *
+.Fn dlFindSymbol "DLLib pLibode" "const char * pSymbolName"
+.Sh DESCRIPTION
+The
+.Nm
+library provides an interface to load foreign dynamic libraries and access
+to their symbols.
+.Pp
+.Fn dlLoadLibrary
+loads a dynamic library at
+.Ar libpath
+and returns a handle to it for use in
+.Fn dlFreeLibrary 
+and
+.Fn dlFindSymbol
+calls.
+.Pp
+.Fn dlFreeLibrary 
+frees the loaded library with handle
+.Ar pLib .
+.Pp
+.Fn dlFindSymbol
+returns a pointer to a symbol with name
+.Ar pSymbolName
+in the library with handle
+.Ar pLib ,
+or returns a null pointer if the symbol cannot be found.
+.Sh SEE ALSO
+.Xr dyncall 3 ,
+.Xr dyncallback 3
+and the dyncall manual (available in PDF format) for a way more detailed documentation of this
+library.
+.Sh AUTHORS
+.An "Daniel Adler" Aq dadler@uni-goettingen.de
+.An "Tassilo Philipp" Aq tphilipp@potion-studios.com