DumontEXE 0.0.1
Public Slots
cmcApplications Class Reference

This is the Commence Running Applications Table. More...

#include <cmcApplications.h>

Inheritance diagram for cmcApplications:

List of all members.

Public Slots

virtual long add (IDispatch *dispatch, const QString &dumontCategory="Dumont")
 Add an Application to the R.O.T.

virtual cmcApplicationapplication (long index)
 Fetch an Application by Index

virtual cmcApplicationapplication (const QString &name)
 Fetch an Application by Name

virtual void checkApps ()
 Check Application References

virtual long remove (IDispatch *dispatch)
 Remove an application by handle

virtual long remove (const QString &name)
 Remove an application from the ROT


Detailed Description

This is the Commence Running Applications Table.

This object manages a list of running Commence applications. When an application is added to the R.O.T., it is scanned regularly to insure that the application is still active. If the user, through Commence, opens a different database then the entry in the ROT will be automatically removed. This feature is timer driven. Once per second, the R.O.T. scans each database to insure it is the correct version for that ROT entry. As long as the user doesn't close Commence or switch databases, then the entry in the R.O.T. will remain current, and will be available to other applications.

The short answer is, don't switch databases when Commence is open, and make sure the application is properly unregistered from the R.O.T. when it closes, otherwise Dumont will maintain a link to that database, and it will not close properly until Dumont is closed.

Definition at line 52 of file cmcApplications.h.


Member Function Documentation

long add ( IDispatch *  dispatch,
const QString &  dumontCategory = "Dumont" 
) [virtual, slot]

Add an Application to the R.O.T.

This function adds an application object directly to the Application R.O.T. in ROT Dumont.

See also:
remove
Returns:
long ~ Count of Applications in the R.O.T.
Parameters:
dispatchinterface pointer ~ Provided directly from vbScript "Application" object

dumontCategorystring ~ name of core Dumont category. Default value is 'Dumont' but can be overridden by the registering application.

Definition at line 91 of file cmcApplications.cpp.

cmcApplication * application ( long  index) [virtual, slot]

Fetch an Application by Index

This function fetches an application from the Application R.O.T. by its instance number.

See also:
application(name)
Returns:
cmcApplication wrapper
Parameters:
indexlong ~ instance index

Definition at line 67 of file cmcApplications.cpp.

cmcApplication * application ( const QString &  name) [virtual, slot]

Fetch an Application by Name

This function fetches an application from the Applications R.O.T. by its application name or alias-name.

See also:
application(index)
Returns:
cmcApplication wrapper
Parameters:
nameString ~ Name or Alias Name of application

Definition at line 74 of file cmcApplications.cpp.

void checkApps ( void  ) [virtual, slot]

Check Application References

This routine loops through all the applications registered in the ROT and removes any application that is referencing the correct database.

Definition at line 53 of file cmcApplications.cpp.

long remove ( const QString &  name) [virtual, slot]

Remove an application from the ROT

Applications are registered in the ROT with a reference to their dispatch interface, and removed from the ROT with a reference to the application's databaseName().

Parameters:
nameString ~ Name or Alias Name of application

Definition at line 143 of file cmcApplications.cpp.

long remove ( IDispatch *  dispatch) [virtual, slot]

Remove an application by handle

This is a convenience function.

Parameters:
dispatchdisptch ~ Application Dispatch pointer

Definition at line 170 of file cmcApplications.cpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties




~ ~ ~ ~ ~ ~
Source Code without Comments is like a Cranberry Garland
without the berries. Comment your Code!
 
Commence Database User Support Group Forum
http://newsgroup.showoff-db.org/
~ ~ ~ ~ ~ ~
Author: Mark Petryk
Lorimark Solutions, LLC
mark@lorimarksolutions.com