Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

XPLC_ModuleInfo Struct Reference

#include <module.h>

List of all members.


Detailed Description

Information for an XPLC module.


Public Attributes

unsigned long magic
 XPLC module magic number.
unsigned int version_major
 The XPLC module ABI version that this module conforms to.
unsigned int version_minor
 The XPLC module ABI sub-version that this module conforms to.
const char * description
 Description string for the module.
const XPLC_ComponentEntry
*const 
components
 List of components supported by the module.
bool(* loadModule )()
 Hook on module loading.
bool(* unloadModule )()
 Hook on module unloading.


Member Data Documentation

unsigned long XPLC_ModuleInfo::magic
 

XPLC module magic number.

This is to ensure that it is in fact a valid XPLC module that has been loaded.

unsigned int XPLC_ModuleInfo::version_major
 

The XPLC module ABI version that this module conforms to.

This should always be the first member of the XPLC_ModuleInfo structure, as the meaning of the following members depend on it.

unsigned int XPLC_ModuleInfo::version_minor
 

The XPLC module ABI sub-version that this module conforms to.

This is used for optional and backward-compatible changes in the module ABI.

const XPLC_ComponentEntry* const XPLC_ModuleInfo::components
 

List of components supported by the module.

This is a pointer to the list of components that will be made available by this module.

bool(* XPLC_ModuleInfo::loadModule)()
 

Hook on module loading.

If not NULL, the function pointed at by loadModule will be called when loading the module. If the return value is false, the loading will be aborted.

bool(* XPLC_ModuleInfo::unloadModule)()
 

Hook on module unloading.

If not NULL, the function pointed at by unloadModule will be called before unloading the module. If the return value is false, the unloading will be aborted and the module will be kept in memory.


The documentation for this struct was generated from the following file:
Generated on Sun Jul 10 15:31:38 2005 for WvStreams by  doxygen 1.4.0