File Name
Syntax
CommandHelpEvent ( REF Integer: dummy )
Parameters
dummy - not used
Returns
None
Side Effects
None
Description
This the event handler for the Command help screen It is used instead of $NullHandler because it must load appropriate values for commandline arguments from c_gconst.kb, which it cannot do in the .df file.
Dialog Forms Called
None
File Name
Syntax
ConfigEvent ( REF ConfigData: ConfigRecord )
Parameters
ConfigData - parameters for the solutions purge operation.
Returns
None
Side Effects
None
Description
This the event handler for the Configuration Options screen
Dialog Forms Called
solpurge.dfc[warning]
File Name
Syntax
Main ( VAL Args: LIST OF STRING )
Parameters
args - the commandline parameters
Returns
None
Side Effects
None
Description
This is the entry point into the Solutions Purge utility. It handles logon, configuration setup and window creation.
Dialog Forms Called
tivint.dfc[frm_tiv_swdist]
tivint.dfc[frm_tiv_rc]
tivint.dfc[frm_tiv_password]
tivint.dfc[frm_tiv_rc_admin]
File Name
Syntax
MainEvent ( REF RunUnattended: BOOLEAN )
Parameters
RunUnattended
Returns
None
Side Effects
None
Description
This is the event handler for the main Solutions Purge Window. It sets the program up and handles Menu messages.
Dialog Forms Called
solpurge.dfc[about]
solpurge.dfc[command_help]
solpurge.dfc[sol_purge_config]
tivint.dfc[frm_tiv_swdist]
tivint.dfc[frm_tiv_rc]
tivint.dfc[frm_tiv_password]
tivint.dfc[frm_tiv_rc_admin]
File Name
Syntax
PurgeSolutions( VAL Handle: window, REF ConfigData: ConfigRecord )
Parameters
Handle - the main window screen - where messages will be written
ConfigData - parameters for the solutions purge operation.
Returns
None
Side Effects
None
Description
This is the function that actuall does the purging of solutions. It deletes the solutions and writes to the screen what it's doing. A nice addition to this would be to make this its own thread, so that it would not seem like this wasn't doing anything.
Dialog Forms Called
None
File Name
Syntax
ReadConfig( ref ConfigData: ConfigRecord )
Parameters
ConfigData - the ConfigRecord structure that the data will be read into.
Returns
ConfigData - the ConfigRecord structure that the data will be read into.
Side Effects
None
Description
This function reads default configuration data from the $SAIni file.
Dialog Forms Called
None
File Name
Syntax
RunUnAttended ( VAL Args: LIST OF STRING )
Parameters
args - the commandline parameters
Returns
$Result - TRUE if the process should run unattended,
FALSE otherwise.
Side Effects
None
Description
This function looks for the '/R' parameter and returns true if it finds it, false otherwise.
Dialog Forms Called
None
File Name
Syntax
SolutionSelection( ref ConfigData: ConfigRecord )
Parameters
ConfigData - The parameters regarding the solution purge.
Returns
$Result - a 'WHERE' string used for selecting the solutions
that are to be purged.
Side Effects
None
Description
This function builds a 'WHERE' string for finding the solutions to be purged, based on the data in ConfigData.
Dialog Forms Called
None
File Name
Syntax
WriteConfig( REF ConfigData: ConfigRecord )
Parameters
ConfigData - the ConfigRecord structure containing the dat to be written.
Returns
None
Side Effects
None
Description
This function writes default configuration data to the $SAIni file.
Dialog Forms Called
None