OGRE-Next  3.0.0unstable
Object-Oriented Graphics Rendering Engine
Ogre::DynLib Class Reference

Resource holding data about a dynamic library. More...

#include <OgreDynLib.h>

+ Inheritance diagram for Ogre::DynLib:

Public Member Functions

 DynLib (const String &name)
 Default constructor - used by DynLibManager. More...
 
 ~DynLib ()
 Default destructor. More...
 
const StringgetName () const
 Get the name of the library. More...
 
void * getSymbol (const String &strName) const noexcept
 Returns the address of the given symbol from the loaded library. More...
 
bool isLoaded () const
 Returns true if it's successfully loaded. More...
 
void load (const bool bOptional)
 Load the library. More...
 
void unload ()
 Unload the library. More...
 

Detailed Description

Resource holding data about a dynamic library.

Remarks
This class holds the data required to get symbols from libraries loaded at run-time (i.e. from DLL's for so's)
Author
Adrian Cearn„u (cearn.nosp@m.y@ce.nosp@m.arny..nosp@m.ro)
Since
27 January 2002

Constructor & Destructor Documentation

◆ DynLib()

Ogre::DynLib::DynLib ( const String name)

Default constructor - used by DynLibManager.

Warning
Do not call directly

◆ ~DynLib()

Ogre::DynLib::~DynLib ( )

Default destructor.

Member Function Documentation

◆ getName()

const String& Ogre::DynLib::getName ( ) const
inline

Get the name of the library.

◆ getSymbol()

void* Ogre::DynLib::getSymbol ( const String strName) const
noexcept

Returns the address of the given symbol from the loaded library.

Parameters
strNameThe name of the symbol to search for
Returns
If the function succeeds, the returned value is a handle to the symbol.
If the function fails, the returned value is NULL.

◆ isLoaded()

bool Ogre::DynLib::isLoaded ( ) const

Returns true if it's successfully loaded.

◆ load()

void Ogre::DynLib::load ( const bool  bOptional)

Load the library.

Parameters
bOptionalWhen true, we will skip it if it fails to initialize

◆ unload()

void Ogre::DynLib::unload ( )

Unload the library.


The documentation for this class was generated from the following file: