annotate 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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
1 .\" Copyright (c) 2007-2014 Daniel Adler <dadler AT uni-goettingen DOT de>,
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
2 .\" Tassilo Philipp <tphilipp AT potion-studios DOT com>
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
3 .\"
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
4 .\" Permission to use, copy, modify, and distribute this software for any
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
5 .\" purpose with or without fee is hereby granted, provided that the above
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
6 .\" copyright notice and this permission notice appear in all copies.
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
7 .\"
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
15 .\"
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
16 .Dd $Mdocdate$
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
17 .Dt dynload 3
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
18 .Os
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
19
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
20 .Sh NAME
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
21 .Nm dynload
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
22 .Nd encapsulates dynamic loading mechanisms and
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
23 gives access to functions in foreign dynamic libraries and code modules.
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
24 .Sh SYNOPSIS
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
25 .In dynload.h
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
26 .Ft DLLib *
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
27 .Fn dlLoadLibrary "const char * libpath"
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
28 .Ft void
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
29 .Fn dlFreeLibrary "DLLib * pLib"
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
30 .Ft void *
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
31 .Fn dlFindSymbol "DLLib pLibode" "const char * pSymbolName"
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
32 .Sh DESCRIPTION
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
33 The
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
34 .Nm
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
35 library provides an interface to load foreign dynamic libraries and access
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
36 to their symbols.
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
37 .Pp
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
38 .Fn dlLoadLibrary
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
39 loads a dynamic library at
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
40 .Ar libpath
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
41 and returns a handle to it for use in
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
42 .Fn dlFreeLibrary
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
43 and
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
44 .Fn dlFindSymbol
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
45 calls.
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
46 .Pp
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
47 .Fn dlFreeLibrary
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
48 frees the loaded library with handle
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
49 .Ar pLib .
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
50 .Pp
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
51 .Fn dlFindSymbol
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
52 returns a pointer to a symbol with name
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
53 .Ar pSymbolName
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
54 in the library with handle
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
55 .Ar pLib ,
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
56 or returns a null pointer if the symbol cannot be found.
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
57 .Sh SEE ALSO
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
58 .Xr dyncall 3 ,
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
59 .Xr dyncallback 3
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
60 and the dyncall manual (available in PDF format) for a way more detailed documentation of this
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
61 library.
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
62 .Sh AUTHORS
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
63 .An "Daniel Adler" Aq dadler@uni-goettingen.de
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
64 .An "Tassilo Philipp" Aq tphilipp@potion-studios.com