[wxWidgets.git] / docs / latex / wx / dynlib.tex

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Name:        dynlib.tex
%% Purpose:     wxDynamicLibrary documentation
%% Author:      Vadim Zeitlin
%% Modified by:
%% Created:     14.01.02 (extracted from dllload.tex)
%% RCS-ID:      $Id$
%% Copyright:   (c) Vadim Zeitlin
%% License:     wxWindows license
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\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.
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
	30	\membersection{wxDynamicLibrary::IsLoaded}\label{wxdynamiclibraryisloaded}
	31
	32	\constfunc{bool}{IsLoaded}{\void}
	33
	34	Returns TRUE if the library was successfully loaded, FALSE otherwise.
	35
	36	\membersection{wxDynamicLibrary::Load}\label{wxdynamiclibraryload}
	37
	38	\func{bool}{Load}{\param{const wxString\& }{name}}
	39
	40	Loads DLL into memory.
	41
	42	Returns TRUE if the library was successfully loaded, FALSE otherwise.
	43
	44	\membersection{wxDynamicLibrary::Unload}\label{wxdynamiclibraryunload}
	45
	46	\func{void}{Unload}{\void}
	47
	48	Unloads the library from memory.
	49
	50	\membersection{wxDynamicLibrary::GetSymbol}\label{wxdynamiclibrarygetsymbol}
	51
	52	\constfunc{void*}{GetSymbol}{\param{const wxString\& }{name}}
	53
	54	Returns pointer to symbol {\it name} in the library or NULL if the library
	55	contains no such symbol.
	56
	57