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{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{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::GetProgramHandle}\label{wxdynamiclibrarygetprogramhandle}
 107
 108 \func{static wxDllType}{GetProgramHandle}{\void}
 109
 110 Return a valid handle for the main program itself or \texttt{NULL} if symbols
 111 from the main program can't be loaded on this platform.
 112
 113
 114 \membersection{wxDynamicLibrary::HasSymbol}\label{wxdynamiclibraryhassymbol}
 115
 116 \constfunc{bool}{HasSymbol}{\param{const wxString\& }{name}}
 117
 118 Returns \true if the symbol with the given \arg{name} is present in the dynamic
 119 library, \false otherwise. Unlike \helpref{GetSymbol}{wxdynamiclibrarygetsymbol},
 120 this function doesn't log an error message if the symbol is not found.
 121
 122 \newsince{2.5.4}
 123
 124
 125 \membersection{wxDynamicLibrary::IsLoaded}\label{wxdynamiclibraryisloaded}
 126
 127 \constfunc{bool}{IsLoaded}{\void}
 128
 129 Returns \true if the library was successfully loaded, \false otherwise.
 130
 131
 132 \membersection{wxDynamicLibrary::ListLoaded}\label{wxdynamiclibrarylistloaded}
 133
 134 \func{static wxDynamicLibraryDetailsArray}{ListLoaded}{\void}
 135
 136 This static method returns an \helpref{array}{wxarray} containing the details
 137 of all modules loaded into the address space of the current project, the array
 138 elements are object of \texttt{wxDynamicLibraryDetails} class. The array will
 139 be empty if an error occurred.
 140
 141 This method is currently implemented only under Win32 and Linux and is useful
 142 mostly for diagnostics purposes.
 143
 144
 145 \membersection{wxDynamicLibrary::Load}\label{wxdynamiclibraryload}
 146
 147 \func{bool}{Load}{\param{const wxString\& }{name}, \param{int }{flags = wxDL\_DEFAULT}}
 148
 149 Loads DLL with the given \arg{name} into memory. The \arg{flags} argument can
 150 be a combination of the following bits:
 151
 152 \begin{twocollist}
 153 \twocolitem{wxDL\_LAZY}{equivalent of RTLD\_LAZY under Unix, ignored elsewhere}
 154 \twocolitem{wxDL\_NOW}{equivalent of RTLD\_NOW under Unix, ignored elsewhere}
 155 \twocolitem{wxDL\_GLOBAL}{equivalent of RTLD\_GLOBAL under Unix, ignored elsewhere}
 156 \twocolitem{wxDL\_VERBATIM}{don't try to append the appropriate extension to
 157 the library name (this is done by default).}
 158 \twocolitem{wxDL\_DEFAULT}{default flags, same as wxDL\_NOW currently}
 159 \end{twocollist}
 160
 161 Returns \true if the library was successfully loaded, \false otherwise.
 162
 163
 164 \membersection{wxDynamicLibrary::Unload}\label{wxdynamiclibraryunload}
 165
 166 \func{void}{Unload}{\void}
 167
 168 \func{static void}{Unload}{\param{wxDllType }{handle}}
 169
 170 Unloads the library from memory. wxDynamicLibrary object automatically calls
 171 this method from its destructor if it had been successfully loaded.
 172
 173 The second version is only used if you need to keep the library in memory
 174 during a longer period of time than the scope of the wxDynamicLibrary object.
 175 In this case you may call \helpref{Detach}{wxdynamiclibrarydetach} and store
 176 the handle somewhere and call this static method later to unload it.
 177
 178 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 179
 180 \section{\class{wxDynamicLibraryDetails}}\label{wxdynamiclibrarydetails}
 181
 182 This class is used for the objects returned by
 183 \helpref{wxDynamicLibrary::ListLoaded}{wxdynamiclibrarylistloaded} method and
 184 contains the information about a single module loaded into the address space of
 185 the current process. A module in this context may be either a dynamic library
 186 or the main program itself.
 187
 188 \wxheading{Derived from}
 189
 190 No base class.
 191
 192 \wxheading{Include files}
 193
 194 <wx/dynlib.h>
 195
 196 (only available if \texttt{wxUSE\_DYNLIB\_CLASS} is set to $1$)
 197
 198 \latexignore{\rtfignore{\wxheading{Members}}}
 199
 200 \membersection{wxDynamicLibraryDetails::GetName}\label{wxdynamiclibrarygetname}
 201
 202 \constfunc{wxString}{GetName}{\void}
 203
 204 Returns the base name of this module, e.g. \texttt{kernel32.dll} or
 205 \texttt{libc-2.3.2.so}.
 206
 207
 208 \membersection{wxDynamicLibraryDetails::GetPath}\label{wxdynamiclibrarygetpath}
 209
 210 \constfunc{wxString}{GetPath}{\void}
 211
 212 Returns the full path of this module if available, e.g.
 213 \texttt{c:$\backslash$windows$\backslash$system32$\backslash$kernel32.dll} or
 214 \texttt{/lib/libc-2.3.2.so}.
 215
 216
 217 \membersection{wxDynamicLibraryDetails::GetAddress}\label{wxdynamiclibrarygetaddress}
 218
 219 \constfunc{bool}{GetAddress}{\param{void **}{addr}, \param{size\_t }{*len}}
 220
 221 Retrieves the load address and the size of this module.
 222
 223 \wxheading{Parameters}
 224
 225 \docparam{addr}{the pointer to the location to return load address in, may be
 226 \texttt{NULL}}
 227
 228 \docparam{len}{pointer to the location to return the size of this module in
 229 memory in, may be \texttt{NULL}}
 230
 231 \wxheading{Return value}
 232
 233 \true if the load address and module size were retrieved, \false if this
 234 information is not available.
 235
 236
 237 \membersection{wxDynamicLibraryDetails::GetVersion}\label{wxdynamiclibrarygetversion}
 238
 239 \constfunc{wxString}{GetVersion}{\void}
 240
 241 Returns the version of this module, e.g. \texttt{5.2.3790.0} or
 242 \texttt{2.3.2}. The returned string is empty if the version information is not
 243 available.
 244