projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| f3845e88 VZ |
1 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 2 | %% Name: dynlib.tex | |
| 3 | %% Purpose: wxDynamicLibrary 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.). It is implemented as a wrapper | |
| 16 | to \helpref{wxDllLoader}{wxdllloader}. | |
| 17 | ||
| 18 | \wxheading{See also} | |
| 19 | ||
| 20 | \helpref{wxDllLoader}{wxdllloader} | |
| 21 | ||
| 22 | \membersection{wxDynamicLibrary::wxDynamicLibrary}\label{wxdynamiclibrarywxdynamiclibrary} | |
| 23 | ||
| 24 | \func{}{wxDynamicLibrary}{\void} | |
| 25 | ||
| 26 | \func{}{wxDynamicLibrary}{\param{const wxString\& }{name}} | |
| 27 | ||
| 28 | Constructor. Second form calls \helpref{Load}{wxdynamiclibraryload}. | |
| 29 | ||
| 9ae2ec95 VZ |
30 | \membersection{wxDynamicLibrary::Detach}\label{wxdynamiclibrarydetach} |
| 31 | ||
| 32 | \func{wxDllType}{Detach}{\void} | |
| 33 | ||
| 34 | Detaches this object from its library handle, i.e. the object will not unload | |
| 35 | the library any longer in its destructor but it is now the callers | |
| 36 | responsability to do this. | |
| 37 | ||
| f3845e88 VZ |
38 | \membersection{wxDynamicLibrary::IsLoaded}\label{wxdynamiclibraryisloaded} |
| 39 | ||
| 40 | \constfunc{bool}{IsLoaded}{\void} | |
| 41 | ||
| cc81d32f | 42 | Returns true if the library was successfully loaded, false otherwise. |
| f3845e88 VZ |
43 | |
| 44 | \membersection{wxDynamicLibrary::Load}\label{wxdynamiclibraryload} | |
| 45 | ||
| 46 | \func{bool}{Load}{\param{const wxString\& }{name}} | |
| 47 | ||
| 48 | Loads DLL into memory. | |
| 49 | ||
| cc81d32f | 50 | Returns true if the library was successfully loaded, false otherwise. |
| f3845e88 VZ |
51 | |
| 52 | \membersection{wxDynamicLibrary::Unload}\label{wxdynamiclibraryunload} | |
| 53 | ||
| 54 | \func{void}{Unload}{\void} | |
| 55 | ||
| 56 | Unloads the library from memory. | |
| 57 | ||
| 58 | \membersection{wxDynamicLibrary::GetSymbol}\label{wxdynamiclibrarygetsymbol} | |
| 59 | ||
| 60 | \constfunc{void*}{GetSymbol}{\param{const wxString\& }{name}} | |
| 61 | ||
| 62 | Returns pointer to symbol {\it name} in the library or NULL if the library | |
| 63 | contains no such symbol. | |
| 64 | ||
| 65 |