2003-04-18 00:22:51 +08:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
< HTML >
< HEAD >
< TITLE > class OSGDB_EXPORT osgDB::DynamicLibrary< / TITLE >
< META NAME = "GENERATOR" CONTENT = "DOC++ 3.4.10" >
< / HEAD >
< BODY BGCOLOR = "#ffffff" >
< H2 > class OSGDB_EXPORT < A HREF = "#DOC.DOCU" > osgDB::DynamicLibrary< / A > < / H2 > < / H2 > < BLOCKQUOTE > DynamicLibrary - encapsulates the loading and unloading of dynamic libraries, typically used for loading ReaderWriter plug-ins< / BLOCKQUOTE >
< HR >
< H2 > Inheritance:< / H2 >
< APPLET CODE = "ClassGraph.class" WIDTH = 600 HEIGHT = 65 >
< param name = classes value = "Mosg::Referenced,M,CDynamicLibrary,MDynamicLibrary.html" >
< param name = before value = "M,M" >
< param name = after value = "Md_,M" >
< param name = indent value = "0,1" >
< param name = arrowdir value = "down" >
< / APPLET >
< HR >
< DL >
< P > < DL >
< DT > < H3 > Public Methods< / H3 > < DD > < DT >
2003-07-23 19:27:31 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > static <!1> < A HREF = "DynamicLibrary.html" > DynamicLibrary< / A > * < B > < A HREF = "#DOC.2.3.3" > loadLibrary< / A > < / B > (const std::string& libraryName)
2003-04-18 00:22:51 +08:00
< DD > < I > returns a pointer to a DynamicLibrary object on successfully opening of library returns NULL on failure< / I >
< DT >
2003-07-23 19:27:31 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > const std::string& < B > < A HREF = "#DOC.2.3.4" > getName< / A > < / B > () const
2003-04-18 00:22:51 +08:00
< DD > < I > return name of library stripped of path< / I >
< DT >
2003-07-23 19:27:31 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > const std::string& < B > < A HREF = "#DOC.2.3.5" > getFullName< / A > < / B > () const
2003-04-18 00:22:51 +08:00
< DD > < I > return name of library including full path to it< / I >
< DT >
2003-07-23 19:27:31 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > <!1> < A HREF = "DynamicLibrary.html#DOC.2.3.1" > HANDLE< / A > < B > < A HREF = "#DOC.2.3.6" > getHandle< / A > < / B > () const
2003-04-18 00:22:51 +08:00
< DD > < I > return handle to dso/dll dynamic library itself< / I >
< DT >
2003-07-23 19:27:31 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > <!1> < A HREF = "DynamicLibrary.html#DOC.2.3.2" > PROC_ADDRESS< / A > < B > < A HREF = "#DOC.2.3.7" > getProcAddress< / A > < / B > (const std::string& procName)
2003-04-18 00:22:51 +08:00
< DD > < I > return address of function located in library< / I >
< / DL > < / P >
< P > < DL >
< DT > < H3 > Public Members< / H3 > < DD > < DT >
2003-07-23 19:27:31 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > typedef void* < B > < A HREF = "#DOC.2.3.1" > HANDLE< / A > < / B >
2003-04-18 00:22:51 +08:00
< DT >
2003-07-23 19:27:31 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > typedef void* < B > < A HREF = "#DOC.2.3.2" > PROC_ADDRESS< / A > < / B >
2003-04-18 00:22:51 +08:00
< / DL > < / P >
< P > < DL >
< DT > < H3 > Protected Fields< / H3 > < DD > < DT >
2003-07-23 19:27:31 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > <!1> < A HREF = "DynamicLibrary.html#DOC.2.3.1" > HANDLE< / A > < B > < A HREF = "#DOC.2.3.14" > _handle< / A > < / B >
2003-04-18 00:22:51 +08:00
< DT >
2003-07-23 19:27:31 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > std::string < B > < A HREF = "#DOC.2.3.15" > _name< / A > < / B >
2003-04-18 00:22:51 +08:00
< DT >
2003-07-23 19:27:31 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > std::string < B > < A HREF = "#DOC.2.3.16" > _fullName< / A > < / B >
2003-04-18 00:22:51 +08:00
< / DL > < / P >
< P > < DL >
< DT > < H3 > Protected Methods< / H3 > < DD > < DT >
2003-07-23 19:27:31 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > static <!1> < A HREF = "DynamicLibrary.html#DOC.2.3.1" > HANDLE< / A > < B > < A HREF = "#DOC.2.3.8" > getLibraryHandle< / A > < / B > ( const std::string& libraryName)
2003-04-18 00:22:51 +08:00
< DD > < I > get handle to library file < / I >
< DT >
2003-07-23 19:27:31 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > < B > < A HREF = "#DOC.2.3.9" > DynamicLibrary< / A > < / B > ()
2003-04-18 00:22:51 +08:00
< DD > < I > disallow default constructor< / I >
< DT >
2003-07-23 19:27:31 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > < B > < A HREF = "#DOC.2.3.10" > DynamicLibrary< / A > < / B > (const <!1> < A HREF = "DynamicLibrary.html#DOC.2.3.10" > DynamicLibrary< / A > & )
2003-04-18 00:22:51 +08:00
< DD > < I > disallow copy constructor< / I >
< DT >
2003-07-23 19:27:31 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > <!1> < A HREF = "DynamicLibrary.html" > DynamicLibrary< / A > & < B > < A HREF = "#DOC.2.3.11" > operator == < / A > < / B > (const <!1> < A HREF = "DynamicLibrary.html" > DynamicLibrary< / A > & )
2003-04-18 00:22:51 +08:00
< DD > < I > disallow copy operator< / I >
< DT >
2003-07-23 19:27:31 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > < B > < A HREF = "#DOC.2.3.12" > DynamicLibrary< / A > < / B > (const std::string& name, <!1> < A HREF = "DynamicLibrary.html#DOC.2.3.1" > HANDLE< / A > handle)
2003-04-18 00:22:51 +08:00
< DD > < I > Disallow public construction so that users have to go through loadLibrary() above which returns NULL on failure, a valid DynamicLibrary object on success< / I >
< DT >
2003-07-23 19:27:31 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > < B > < A HREF = "#DOC.2.3.13" > ~DynamicLibrary< / A > < / B > ()
2003-04-18 00:22:51 +08:00
< / DL > < / P >
< / DL >
< A NAME = "DOC.DOCU" > < / A >
< HR >
< H2 > Documentation< / H2 >
< BLOCKQUOTE > DynamicLibrary - encapsulates the loading and unloading of dynamic libraries,
typically used for loading ReaderWriter plug-ins< / BLOCKQUOTE >
< DL >
< A NAME = "HANDLE" > < / A >
2003-07-23 19:27:31 +08:00
< A NAME = "DOC.2.3.1" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > typedef void* HANDLE< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "PROC_ADDRESS" > < / A >
2003-07-23 19:27:31 +08:00
< A NAME = "DOC.2.3.2" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > typedef void* PROC_ADDRESS< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "loadLibrary" > < / A >
2003-07-23 19:27:31 +08:00
< A NAME = "DOC.2.3.3" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > static <!1> < A HREF = "DynamicLibrary.html" > DynamicLibrary< / A > * loadLibrary(const std::string& libraryName)< / B > < / TT >
< DD > returns a pointer to a DynamicLibrary object on successfully
opening of library returns NULL on failure
< DL > < DT > < DD > < / DL > < P >
< A NAME = "getName" > < / A >
2003-07-23 19:27:31 +08:00
< A NAME = "DOC.2.3.4" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > const std::string& getName() const < / B > < / TT >
< DD > return name of library stripped of path
< DL > < DT > < DD > < / DL > < P >
< A NAME = "getFullName" > < / A >
2003-07-23 19:27:31 +08:00
< A NAME = "DOC.2.3.5" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > const std::string& getFullName() const < / B > < / TT >
< DD > return name of library including full path to it
< DL > < DT > < DD > < / DL > < P >
< A NAME = "getHandle" > < / A >
2003-07-23 19:27:31 +08:00
< A NAME = "DOC.2.3.6" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > <!1> < A HREF = "DynamicLibrary.html#DOC.2.3.1" > HANDLE< / A > getHandle() const < / B > < / TT >
2003-04-18 00:22:51 +08:00
< DD > return handle to dso/dll dynamic library itself
< DL > < DT > < DD > < / DL > < P >
< A NAME = "getProcAddress" > < / A >
2003-07-23 19:27:31 +08:00
< A NAME = "DOC.2.3.7" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > <!1> < A HREF = "DynamicLibrary.html#DOC.2.3.2" > PROC_ADDRESS< / A > getProcAddress(const std::string& procName)< / B > < / TT >
2003-04-18 00:22:51 +08:00
< DD > return address of function located in library
< DL > < DT > < DD > < / DL > < P >
< A NAME = "getLibraryHandle" > < / A >
2003-07-23 19:27:31 +08:00
< A NAME = "DOC.2.3.8" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > static <!1> < A HREF = "DynamicLibrary.html#DOC.2.3.1" > HANDLE< / A > getLibraryHandle( const std::string& libraryName)< / B > < / TT >
2003-04-18 00:22:51 +08:00
< DD > get handle to library file
< DL > < DT > < DD > < / DL > < P >
< A NAME = "DynamicLibrary" > < / A >
2003-07-23 19:27:31 +08:00
< A NAME = "DOC.2.3.9" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > DynamicLibrary()< / B > < / TT >
< DD > disallow default constructor
< DL > < DT > < DD > < / DL > < P >
< A NAME = "DynamicLibrary" > < / A >
2003-07-23 19:27:31 +08:00
< A NAME = "DOC.2.3.10" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > DynamicLibrary(const <!1> < A HREF = "DynamicLibrary.html#DOC.2.3.10" > DynamicLibrary< / A > & )< / B > < / TT >
2003-04-18 00:22:51 +08:00
< DD > disallow copy constructor
< DL > < DT > < DD > < / DL > < P >
< A NAME = "operator == " > < / A >
2003-07-23 19:27:31 +08:00
< A NAME = "DOC.2.3.11" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > <!1> < A HREF = "DynamicLibrary.html" > DynamicLibrary< / A > & operator == (const <!1> < A HREF = "DynamicLibrary.html" > DynamicLibrary< / A > & )< / B > < / TT >
< DD > disallow copy operator
< DL > < DT > < DD > < / DL > < P >
< A NAME = "DynamicLibrary" > < / A >
2003-07-23 19:27:31 +08:00
< A NAME = "DOC.2.3.12" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > DynamicLibrary(const std::string& name, <!1> < A HREF = "DynamicLibrary.html#DOC.2.3.1" > HANDLE< / A > handle)< / B > < / TT >
2003-04-18 00:22:51 +08:00
< DD > Disallow public construction so that users have to go
through loadLibrary() above which returns NULL on
failure, a valid DynamicLibrary object on success
< DL > < DT > < DD > < / DL > < P >
< A NAME = "~DynamicLibrary" > < / A >
2003-07-23 19:27:31 +08:00
< A NAME = "DOC.2.3.13" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > ~DynamicLibrary()< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "_handle" > < / A >
2003-07-23 19:27:31 +08:00
< A NAME = "DOC.2.3.14" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > <!1> < A HREF = "DynamicLibrary.html#DOC.2.3.1" > HANDLE< / A > _handle< / B > < / TT >
2003-04-18 00:22:51 +08:00
< DL > < DT > < DD > < / DL > < P >
< A NAME = "_name" > < / A >
2003-07-23 19:27:31 +08:00
< A NAME = "DOC.2.3.15" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > std::string _name< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "_fullName" > < / A >
2003-07-23 19:27:31 +08:00
< A NAME = "DOC.2.3.16" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > std::string _fullName< / B > < / TT >
< DL > < DT > < DD > < / DL > < P > < / DL >
< HR > < DL > < DT > < B > This class has no child classes.< / B > < / DL >
< DL > < DT > < DD > < / DL > < P > < P > < I > < A HREF = "index.html" > Alphabetic index< / A > < / I > < I > < A HREF = "HIER.html" > HTML hierarchy of classes< / A > or < A HREF = "HIERjava.html" > Java< / A > < / I > < / P > < HR >
< BR >
This page was generated with the help of < A HREF = "http://docpp.sourceforge.net" > DOC++< / A > .
< / BODY >
< / HTML >
