#include <YUIPlugin.h>

Inheritance diagram for YUIPlugin:

Public Member Functions
	YUIPlugin (const char *pluginLibBaseName)

virtual	~YUIPlugin ()

void	unload ()

void *	locateSymbol (const char *symbol)

bool	error () const

bool	success () const

std::string	errorMsg () const

Protected Member Functions
void *	pluginLibHandle ()

std::string	pluginLibBaseName () const

std::string	pluginLibFullPath () const

Detailed Description

Wrapper class for dlopen() and related.

Constructor & Destructor Documentation

◆ YUIPlugin()

YUIPlugin::YUIPlugin ( const char * pluginLibBaseName )

Constructor: Load the specified plugin library from the standard UI plugin directory (/usr/lib/yui/).

◆ ~YUIPlugin()

YUIPlugin::~YUIPlugin ( )

virtual

Destructor.

Please note that this will NOT attempt to unload the plugin library since this is usually counterproductive. If unloading the plugin is desired, call unload() manually.

Member Function Documentation

◆ error()

bool YUIPlugin::error ( ) const

Returns 'true' if there was an error loading the plugin.

◆ errorMsg()

string YUIPlugin::errorMsg ( ) const

Returns a human readable (but in most cases untranslated) error message if there was an error.

◆ locateSymbol()

void * YUIPlugin::locateSymbol ( const char * symbol )

Try to locate the specified symbol (function or global variable) in the plugin library.

Returns the in-memory address of that symbol or 0 if it could not be found or if loading the plugin library had failed in the constructor.

◆ pluginLibBaseName()

std::string YUIPlugin::pluginLibBaseName ( ) const

inlineprotected

Returns the base name of the plugin library.

◆ pluginLibFullPath()

string YUIPlugin::pluginLibFullPath ( ) const

protected

Returns the full path of the plugin library.

◆ pluginLibHandle()

void * YUIPlugin::pluginLibHandle ( )

inlineprotected

Returns the dlopen() handle of the plugin library.

◆ success()

bool YUIPlugin::success ( ) const

Returns 'true' if there was no error loading the plugin.

◆ unload()

void YUIPlugin::unload ( )

Unload this plugin. This calls dlclose() which will unload the plugin library if it is no longer used, i.e. if the reference count dlopen() uses reaches 0.

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

/__w/libyui/libyui/libyui/src/YUIPlugin.h
/__w/libyui/libyui/libyui/src/YUIPlugin.cc

Public Member Functions

Protected Member Functions