]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/dynlib.tex
wxURI/wxURL links in changes list.
[wxWidgets.git] / docs / latex / wx / dynlib.tex
index 6712c0b87d662b4bc6dfb9f1007a3b975936f3fd..59ef7f8a828215d283e61c2bbb6ea0cdb94bb140 100644 (file)
@@ -6,7 +6,7 @@
 %% Created:     14.01.02 (extracted from dllload.tex)
 %% RCS-ID:      $Id$
 %% Copyright:   (c) Vadim Zeitlin
-%% License:     wxWindows license
+%% License:     wxWidgets license
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxDynamicLibrary}}\label{wxdynamiclibrary}
@@ -23,6 +23,7 @@ done in the objects destructor automatically.
 %\helpref{wxDllLoader}{wxdllloader}
 
 
+
 \membersection{wxDynamicLibrary::wxDynamicLibrary}\label{wxdynamiclibrarywxdynamiclibrary}
 
 \func{}{wxDynamicLibrary}{\void}
@@ -31,6 +32,7 @@ done in the objects destructor automatically.
 
 Constructor. Second form calls \helpref{Load}{wxdynamiclibraryload}.
 
+
 \membersection{wxDynamicLibrary::CanonicalizeName}\label{wxdynamiclibrarycanonicalizename}
 
 \func{wxString}{CanonicalizeName}{\param{const wxString\& }{name}, \param{wxDynamicLibraryCategory}{ cat = wxDL\_LIBRARY}}
@@ -51,12 +53,13 @@ The possible values for \arg{cat} are:
 \helpref{CanonicalizePluginName}{wxdynamiclibrarycanonicalizepluginname}
 
 
+
 \membersection{wxDynamicLibrary::CanonicalizePluginName}\label{wxdynamiclibrarycanonicalizepluginname}
 
 \func{wxString}{CanonicalizePluginName}{\param{const wxString\& }{name}, \param{wxPluginCategory}{ cat = wxDL\_PLUGIN\_GUI}}
 
 This function does the same thing as 
-\helpref{CanonicalizeName}{wxdynamiclibrarycanonicalizename} but for wxWindows
+\helpref{CanonicalizeName}{wxdynamiclibrarycanonicalizename} but for wxWidgets
 plugins. The only difference is that compiler and version information are added
 to the name to ensure that the plugin which is going to be loaded will be
 compatible with the main program.
@@ -68,6 +71,7 @@ The possible values for \arg{cat} are:
     \twocolitem{wxDL\_PLUGIN\_BASE}{plugin which only uses wxBase}
 \end{twocollist}
 
+
 \membersection{wxDynamicLibrary::Detach}\label{wxdynamiclibrarydetach}
 
 \func{wxDllType}{Detach}{\void}
@@ -76,9 +80,10 @@ Detaches this object from its library handle, i.e. the object will not unload
 the library any longer in its destructor but it is now the callers
 responsability to do this using \helpref{Unload}{wxdynamiclibraryunload}.
 
+
 \membersection{wxDynamicLibrary::GetSymbol}\label{wxdynamiclibrarygetsymbol}
 
-\constfunc{void*}{GetSymbol}{\param{const wxString\& }{name}}
+\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.
@@ -87,18 +92,32 @@ contains no such symbol.
 
 \helpref{wxDYNLIB\_FUNCTION}{wxdynlibfunction}
 
+
+\membersection{wxDynamicLibrary::HasSymbol}\label{wxdynamiclibraryhassymbol}
+
+\constfunc{bool}{HasSymbol}{\param{const wxString\& }{name}}
+
+Returns \true if the symbol with the given \arg{name} is present in the dynamic
+library, \false otherwise. Unlike \helpref{GetSymbol}{wxdynamiclibrarygetsymbol},
+this function doesn't log an error message if the symbol is not found.
+
+\newsince{2.5.4}
+
+
 \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}, \param{int }{flags = wxDL\_DEFAULT}}
 
 Loads DLL with the given \arg{name} into memory. The \arg{flags} argument can
 be a combination of the following bits:
+
 \begin{twocollist}
 \twocolitem{wxDL\_LAZY}{equivalent of RTLD\_LAZY under Unix, ignored elsewhere}
 \twocolitem{wxDL\_NOW}{equivalent of RTLD\_NOW under Unix, ignored elsewhere}
@@ -109,6 +128,7 @@ the library name (this is done by default).}
 
 Returns \true if the library was successfully loaded, \false otherwise.
 
+
 \membersection{wxDynamicLibrary::Unload}\label{wxdynamiclibraryunload}
 
 \func{void}{Unload}{\void}