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