]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/dllload.tex
silence gcc warnings about values not handled in switch
[wxWidgets.git] / docs / latex / wx / dllload.tex
index 9884c577ce2ba26c04ed72522c9cd29ba167aa66..c0f217dfd2be0545f90c9f96153693057fe1babd 100644 (file)
 
 \section{\class{wxDllLoader}}\label{wxdllloader}
 
 
 \section{\class{wxDllLoader}}\label{wxdllloader}
 
+\textbf{Deprecation note: } This class is deprecated since version 2.4 and is
+not compiled in by default in version 2.6 and will be removed in 2.8. Please
+use \helpref{wxDynamicLibrary}{wxdynamiclibrary} instead.
+
+
 wxDllLoader is a class providing an interface similar to Unix's {\tt
 dlopen()}. It is used by the wxLibrary framework and manages the actual
 loading of shared libraries and the resolving of symbols in them. There are no
 wxDllLoader is a class providing an interface similar to Unix's {\tt
 dlopen()}. It is used by the wxLibrary framework and manages the actual
 loading of shared libraries and the resolving of symbols in them. There are no
@@ -74,7 +79,7 @@ No base class
 
 \wxheading{Data structures}
 
 
 \wxheading{Data structures}
 
-This header defines a platfrom-dependent {\tt wxDllType} typedef which stores
+This header defines a platform-dependent {\tt wxDllType} typedef which stores
 a handle to a loaded DLLs on the given platform.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 a handle to a loaded DLLs on the given platform.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
@@ -108,7 +113,7 @@ This function resolves a symbol in a loaded DLL, such as a variable or
 function name.
 
 Returned value will be {\tt NULL} if the symbol was not found in the DLL or if
 function name.
 
 Returned value will be {\tt NULL} if the symbol was not found in the DLL or if
-an error occured.
+an error occurred.
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 
@@ -123,8 +128,8 @@ an error occured.
 
 This function loads a shared library into memory, with {\it libname} being the
 name of the library: it may be either the full name including path and
 
 This function loads a shared library into memory, with {\it libname} being the
 name of the library: it may be either the full name including path and
-(platform-dependent) extenesion, just the basename (no path and no extension)
-or a basename with extentsion. In the last two cases, the library will be
+(platform-dependent) extension, just the basename (no path and no extension)
+or a basename with extension. In the last two cases, the library will be
 searched in all standard locations.
 
 Returns a handle to the loaded DLL. Use {\it success} parameter to test if it
 searched in all standard locations.
 
 Returns a handle to the loaded DLL. Use {\it success} parameter to test if it
@@ -135,8 +140,8 @@ is valid. If the handle is valid, the library must be unloaded later with
 
 \docparam{libname}{Name of the shared object to load.}
 
 
 \docparam{libname}{Name of the shared object to load.}
 
-\docparam{success}{May point to a bool variable which will be set to TRUE or
-FALSE; may also be {\tt NULL}.}
+\docparam{success}{May point to a bool variable which will be set to true or
+false; may also be {\tt NULL}.}
 
 \membersection{wxDllLoader::UnloadLibrary}\label{wxdllloaderunloadlibrary}
 
 
 \membersection{wxDllLoader::UnloadLibrary}\label{wxdllloaderunloadlibrary}
 
@@ -145,48 +150,3 @@ FALSE; may also be {\tt NULL}.}
 This function unloads the shared library. The handle {\it dllhandle} must have
 been returned by \helpref{LoadLibrary}{wxdllloaderloadlibrary} previously.
 
 This function unloads the shared library. The handle {\it dllhandle} must have
 been returned by \helpref{LoadLibrary}{wxdllloaderloadlibrary} previously.
 
-\section{\class{wxDynamicLibrary}}\label{wxdynamiclibrary}
-
-wxDynamicLibrary is a class representing dynamically loadable library
-(Windows DLL, shared library under Unix etc.). It is implemented as a wrapper
-to \helpref{wxDllLoader}{wxdllloader}.
-
-\wxheading{See also}
-
-\helpref{wxDllLoader}{wxdllloader}
-
-\membersection{wxDynamicLibrary::wxDynamicLibrary}\label{wxdynamiclibrarywxdynamiclibrary}
-
-\func{}{wxDynamicLibrary}{\void}
-
-\func{}{wxDynamicLibrary}{\param{const wxString\& }{name}}
-
-Constructor. Second form calls \helpref{Load}{wxdynamiclibraryload}.
-
-\membersection{wxDynamicLibrary::IsLoaded}\label{wxdynamiclibraryisloaded}
-
-\constfunc{bool}{IsLoaded}{\void}
-
-Returns TRUE if the library was successfully loaded, FALSE otherwise.
-
-\membersection{wxDynamicLibrary::Load}\label{wxdynamiclibraryload}
-
-\func{bool}{Load}{\param{const wxString\& }{name}}
-
-Loads DLL into memory.
-
-Returns TRUE if the library was successfully loaded, FALSE otherwise.
-
-\membersection{wxDynamicLibrary::Unload}\label{wxdynamiclibraryunload}
-
-\func{void}{Unload}{\void}
-
-Unloads the library from memory.
-
-\membersection{wxDynamicLibrary::GetSymbol}\label{wxdynamiclibrarygetsymbol}
-
-\constfunc{void*}{GetSymbol}{\param{const wxString\& }{name}}
-
-Returns pointer to symbol {\it name} in the library or NULL if the library
-contains no such symbol.
-