]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/dynlib.tex
Always draw the selection of selected items, not just when they have
[wxWidgets.git] / docs / latex / wx / dynlib.tex
1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2 %% Name: dynlib.tex
3 %% Purpose: wxDynamicLibrary and wxDynamicLibraryDetails documentation
4 %% Author: Vadim Zeitlin
5 %% Modified by:
6 %% Created: 14.01.02 (extracted from dllload.tex)
7 %% RCS-ID: $Id$
8 %% Copyright: (c) Vadim Zeitlin
9 %% License: wxWindows license
10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11
12 \section{\class{wxDynamicLibrary}}\label{wxdynamiclibrary}
13
14 wxDynamicLibrary is a class representing dynamically loadable library
15 (Windows DLL, shared library under Unix etc.). Just create an object of
16 this class to load a library and don't worry about unloading it -- it will be
17 done in the objects destructor automatically.
18
19 % deprecated now...
20 %
21 %\wxheading{See also}
22 %
23 %\helpref{wxDllLoader}{wxdllloader}
24
25 \wxheading{Derived from}
26
27 No base class.
28
29 \wxheading{Include files}
30
31 <wx/dynlib.h>
32
33 (only available if \texttt{wxUSE\_DYNLIB\_CLASS} is set to $1$)
34
35 \latexignore{\rtfignore{\wxheading{Members}}}
36
37 \membersection{wxDynamicLibrary::wxDynamicLibrary}\label{wxdynamiclibrarywxdynamiclibrary}
38
39 \func{}{wxDynamicLibrary}{\void}
40
41 \func{}{wxDynamicLibrary}{\param{const wxString\& }{name}, \param{int }{flags = wxDL\_DEFAULT}}
42
43 Constructor. Second form calls \helpref{Load}{wxdynamiclibraryload}.
44
45
46 \membersection{wxDynamicLibrary::CanonicalizeName}\label{wxdynamiclibrarycanonicalizename}
47
48 \func{static wxString}{CanonicalizeName}{\param{const wxString\& }{name}, \param{wxDynamicLibraryCategory}{ cat = wxDL\_LIBRARY}}
49
50 Returns the platform-specific full name for the library called \arg{name}. E.g.
51 it adds a {\tt ".dll"} extension under Windows and {\tt "lib"} prefix and
52 {\tt ".so"}, {\tt ".sl"} or maybe {\tt ".dylib"} extension under Unix.
53
54 The possible values for \arg{cat} are:
55
56 \begin{twocollist}
57 \twocolitem{wxDL\_LIBRARY}{normal library}
58 \twocolitem{wxDL\_MODULE}{a loadable module or plugin}
59 \end{twocollist}
60
61 \wxheading{See also}
62
63 \helpref{CanonicalizePluginName}{wxdynamiclibrarycanonicalizepluginname}
64
65
66
67 \membersection{wxDynamicLibrary::CanonicalizePluginName}\label{wxdynamiclibrarycanonicalizepluginname}
68
69 \func{static wxString}{CanonicalizePluginName}{\param{const wxString\& }{name}, \param{wxPluginCategory}{ cat = wxDL\_PLUGIN\_GUI}}
70
71 This function does the same thing as
72 \helpref{CanonicalizeName}{wxdynamiclibrarycanonicalizename} but for wxWidgets
73 plugins. The only difference is that compiler and version information are added
74 to the name to ensure that the plugin which is going to be loaded will be
75 compatible with the main program.
76
77 The possible values for \arg{cat} are:
78
79 \begin{twocollist}
80 \twocolitem{wxDL\_PLUGIN\_GUI}{plugin which uses GUI classes (default)}
81 \twocolitem{wxDL\_PLUGIN\_BASE}{plugin which only uses wxBase}
82 \end{twocollist}
83
84
85 \membersection{wxDynamicLibrary::Detach}\label{wxdynamiclibrarydetach}
86
87 \func{wxDllType}{Detach}{\void}
88
89 Detaches this object from its library handle, i.e. the object will not unload
90 the library any longer in its destructor but it is now the callers
91 responsibility to do this using \helpref{Unload}{wxdynamiclibraryunload}.
92
93
94 \membersection{wxDynamicLibrary::GetSymbol}\label{wxdynamiclibrarygetsymbol}
95
96 \constfunc{void *}{GetSymbol}{\param{const wxString\& }{name}}
97
98 Returns pointer to symbol {\it name} in the library or NULL if the library
99 contains no such symbol.
100
101 \wxheading{See also}
102
103 \helpref{wxDYNLIB\_FUNCTION}{wxdynlibfunction}
104
105
106 \membersection{wxDynamicLibrary::GetSymbolAorW}\label{wxdynamiclibrarygetsymbolaorw}
107
108 \constfunc{void *}{GetSymbolAorW}{\param{const wxString\& }{name}}
109
110 This function is available only under Windows as it is only useful when
111 dynamically loading symbols from standard Windows DLLs. Such functions have
112 either \texttt{'A'} (in ANSI build) or \texttt{'W'} (in Unicode, or wide
113 character build) suffix if they take string parameters. Using this function you
114 can use just the base name of the function and the correct suffix is appende
115 automatically depending on the current build. Otherwise, this method is
116 identical to \helpref{GetSymbol}{wxdynamiclibrarygetsymbol}.
117
118
119 \membersection{wxDynamicLibrary::GetProgramHandle}\label{wxdynamiclibrarygetprogramhandle}
120
121 \func{static wxDllType}{GetProgramHandle}{\void}
122
123 Return a valid handle for the main program itself or \texttt{NULL} if symbols
124 from the main program can't be loaded on this platform.
125
126
127 \membersection{wxDynamicLibrary::HasSymbol}\label{wxdynamiclibraryhassymbol}
128
129 \constfunc{bool}{HasSymbol}{\param{const wxString\& }{name}}
130
131 Returns \true if the symbol with the given \arg{name} is present in the dynamic
132 library, \false otherwise. Unlike \helpref{GetSymbol}{wxdynamiclibrarygetsymbol},
133 this function doesn't log an error message if the symbol is not found.
134
135 \newsince{2.5.4}
136
137
138 \membersection{wxDynamicLibrary::IsLoaded}\label{wxdynamiclibraryisloaded}
139
140 \constfunc{bool}{IsLoaded}{\void}
141
142 Returns \true if the library was successfully loaded, \false otherwise.
143
144
145 \membersection{wxDynamicLibrary::ListLoaded}\label{wxdynamiclibrarylistloaded}
146
147 \func{static wxDynamicLibraryDetailsArray}{ListLoaded}{\void}
148
149 This static method returns an \helpref{array}{wxarray} containing the details
150 of all modules loaded into the address space of the current project, the array
151 elements are object of \texttt{wxDynamicLibraryDetails} class. The array will
152 be empty if an error occurred.
153
154 This method is currently implemented only under Win32 and Linux and is useful
155 mostly for diagnostics purposes.
156
157
158 \membersection{wxDynamicLibrary::Load}\label{wxdynamiclibraryload}
159
160 \func{bool}{Load}{\param{const wxString\& }{name}, \param{int }{flags = wxDL\_DEFAULT}}
161
162 Loads DLL with the given \arg{name} into memory. The \arg{flags} argument can
163 be a combination of the following bits:
164
165 \begin{twocollist}
166 \twocolitem{wxDL\_LAZY}{equivalent of RTLD\_LAZY under Unix, ignored elsewhere}
167 \twocolitem{wxDL\_NOW}{equivalent of RTLD\_NOW under Unix, ignored elsewhere}
168 \twocolitem{wxDL\_GLOBAL}{equivalent of RTLD\_GLOBAL under Unix, ignored elsewhere}
169 \twocolitem{wxDL\_VERBATIM}{don't try to append the appropriate extension to
170 the library name (this is done by default).}
171 \twocolitem{wxDL\_DEFAULT}{default flags, same as wxDL\_NOW currently}
172 \end{twocollist}
173
174 Returns \true if the library was successfully loaded, \false otherwise.
175
176
177 \membersection{wxDynamicLibrary::Unload}\label{wxdynamiclibraryunload}
178
179 \func{void}{Unload}{\void}
180
181 \func{static void}{Unload}{\param{wxDllType }{handle}}
182
183 Unloads the library from memory. wxDynamicLibrary object automatically calls
184 this method from its destructor if it had been successfully loaded.
185
186 The second version is only used if you need to keep the library in memory
187 during a longer period of time than the scope of the wxDynamicLibrary object.
188 In this case you may call \helpref{Detach}{wxdynamiclibrarydetach} and store
189 the handle somewhere and call this static method later to unload it.
190
191 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
192
193 \section{\class{wxDynamicLibraryDetails}}\label{wxdynamiclibrarydetails}
194
195 This class is used for the objects returned by
196 \helpref{wxDynamicLibrary::ListLoaded}{wxdynamiclibrarylistloaded} method and
197 contains the information about a single module loaded into the address space of
198 the current process. A module in this context may be either a dynamic library
199 or the main program itself.
200
201 \wxheading{Derived from}
202
203 No base class.
204
205 \wxheading{Include files}
206
207 <wx/dynlib.h>
208
209 (only available if \texttt{wxUSE\_DYNLIB\_CLASS} is set to $1$)
210
211 \latexignore{\rtfignore{\wxheading{Members}}}
212
213 \membersection{wxDynamicLibraryDetails::GetName}\label{wxdynamiclibrarygetname}
214
215 \constfunc{wxString}{GetName}{\void}
216
217 Returns the base name of this module, e.g. \texttt{kernel32.dll} or
218 \texttt{libc-2.3.2.so}.
219
220
221 \membersection{wxDynamicLibraryDetails::GetPath}\label{wxdynamiclibrarygetpath}
222
223 \constfunc{wxString}{GetPath}{\void}
224
225 Returns the full path of this module if available, e.g.
226 \texttt{c:$\backslash$windows$\backslash$system32$\backslash$kernel32.dll} or
227 \texttt{/lib/libc-2.3.2.so}.
228
229
230 \membersection{wxDynamicLibraryDetails::GetAddress}\label{wxdynamiclibrarygetaddress}
231
232 \constfunc{bool}{GetAddress}{\param{void **}{addr}, \param{size\_t }{*len}}
233
234 Retrieves the load address and the size of this module.
235
236 \wxheading{Parameters}
237
238 \docparam{addr}{the pointer to the location to return load address in, may be
239 \texttt{NULL}}
240
241 \docparam{len}{pointer to the location to return the size of this module in
242 memory in, may be \texttt{NULL}}
243
244 \wxheading{Return value}
245
246 \true if the load address and module size were retrieved, \false if this
247 information is not available.
248
249
250 \membersection{wxDynamicLibraryDetails::GetVersion}\label{wxdynamiclibrarygetversion}
251
252 \constfunc{wxString}{GetVersion}{\void}
253
254 Returns the version of this module, e.g. \texttt{5.2.3790.0} or
255 \texttt{2.3.2}. The returned string is empty if the version information is not
256 available.
257