Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIModule Interface Reference

The nsIModule interface. More...

import "nsIModule.idl";

Inheritance diagram for nsIModule:
Inheritance graph
[legend]
Collaboration diagram for nsIModule:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void getClassObject (in nsIComponentManager aCompMgr, in nsCIDRef aClass, in nsIIDRef aIID,[retval, iid_is(aIID)] out nsQIResult aResult)
 Object Instance Creation.
void registerSelf (in nsIComponentManager aCompMgr, in nsIFile aLocation, in string aLoaderStr, in string aType)
 One time registration callback.
void unregisterSelf (in nsIComponentManager aCompMgr, in nsIFile aLocation, in string aLoaderStr)
 One time unregistration callback.
boolean canUnload (in nsIComponentManager aCompMgr)
 Module load management.

Detailed Description

The nsIModule interface.

FROZEN

Definition at line 49 of file nsIModule.idl.


Member Function Documentation

Module load management.

Parameters:
aCompMgr: The global component manager
Returns:
indicates to the caller if the module can be unloaded. Returning PR_TRUE isn't a guarantee that the module will be unloaded. It constitues only willingness of the module to be unloaded. It is very important to ensure that no outstanding references to the module's code/data exist before returning PR_TRUE. Returning PR_FALSE guaratees that the module wont be unloaded.
void nsIModule::getClassObject ( in nsIComponentManager  aCompMgr,
in nsCIDRef  aClass,
in nsIIDRef  aIID,
[retval, iid_is(aIID)] out nsQIResult  aResult 
)

Object Instance Creation.

Obtains a Class Object from a nsIModule for a given CID and IID pair. This class object can either be query to a nsIFactory or a may be query to a nsIClassInfo.

Parameters:
aCompMgr: The global component manager
aClass: ClassID of object instance requested
aIID: IID of interface requested
void nsIModule::registerSelf ( in nsIComponentManager  aCompMgr,
in nsIFile  aLocation,
in string  aLoaderStr,
in string  aType 
)

One time registration callback.

When the nsIModule is discovered, this method will be called so that any setup registration can be preformed.

Parameters:
aCompMgr: The global component manager
aLocation: The location of the nsIModule on disk
aLoaderStr,:Opaque loader specific string
aType: Loader Type being used to load this module
void nsIModule::unregisterSelf ( in nsIComponentManager  aCompMgr,
in nsIFile  aLocation,
in string  aLoaderStr 
)

One time unregistration callback.

When the nsIModule is being unregistered, this method will be called so that any unregistration can be preformed

Parameters:
aCompMgr: The global component manager
aLocation: The location of the nsIModule on disk
aLoaderStr: Opaque loader specific string

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