File Name
Syntax
AppExit
Parameters
None
Returns
None
Side Effects
None
Description
This procedure sends a $MsgClose to the mainWindow handle.
Dialog Forms Called
None
File Name
Syntax
BuildConnectString( VAL args: LIST OF CoreParameterRec, REF connectString: STRING, REF user: UserEventRecor, VAL defaultDSN: STRING )
Parameters
args - list of coreParameterRec
connectString - result connection string
user - user record
defaultDSN - default Data Source
Returns
connectString
Side Effects
None
Description
This procedure takes args, user, and defaultDSN, and uses the values to create a connectString when connecting to the database.
Dialog Forms Called
None
File Name
Syntax
Change_User_Password
Parameters
None
Returns
None
Side Effects
None
Description
This procedure allows the user to change their password for the application. If the c/2 logon method is selected, then the user changes their database password.
Dialog Forms Called
None
File Name
Syntax
ChangeUserPasswordEvent (REF loggedUser: UserEventRecord)
Parameters
loggedUser - user event record for logged user
Returns
loggedUser - user event record for logged user
Side Effects
None
Description
This event handles any processing for the Change User Password form.
Dialog Forms Called
None
File Name
Syntax
CleanUpActionGroups( VAL entityList: LIST OF EntityRecord)
Parameters
entityList - list of EntityRecord
Returns
None
Side Effects
None
Description
This procedure takes the entityList and calls the CleanUp function in each action group KB to ensure that any clean up processing is performed prior to closing the main window (toolbar).
Dialog Forms Called
None
File Name
Syntax
FindCoreParameter ( VAL args: LIST OF CoreParameterRec, VAL argName: STRING, REF parmValue: STRING ): BOOLEAN
Parameters
args - list of parameter values that are used as the lookup list
argName - the argument switch to search for in the lookup list
parmValue - parameter value associated with the argument for which the search is performed
Returns
TRUE - The parameter was found in the list and any value
that is associated with it is stored in the parmValue
parameter.
FALSE - The parameter was not found in the list.
Side Effects
None
Description
This function searches a list of Record for an argument value that is stored in argName. If found, it stores the actual value for this argument in the parmValue parameter.
Dialog Forms Called
None
File Name
Syntax
GetAndLoadFiles( VAL entityList: LIST OF EntityRecord)
Parameters
entityList - list of EntityRecord
Returns
None
Side Effects
None
Description
This procedure takes the entityList and loads the entity files into memory.
Dialog Forms Called
None
File Name
Syntax
GetDefaultDatasource( REF RDBMS: String, REF SQLConfigFile: String ): Integer
Parameters
RDBMS - variable to hold name of SAIDatasource
Returns
TRUE if RDBMS found, FALSE if not found
Side Effects
None
Description
Searches the SAI_SQL.CFG file for the datasource that has been configured as the default. This funtion uses the TSD Script ini* commands, which were added since the creation of SABuild.
Dialog Forms Called
None
File Name
Syntax
LogOnEvent ( REF User: UserEventRecord)
Parameters
user - user record
Returns
User record, with user ID and password
Side Effects
None
Description
This event displays the application title and receives the user ID and password the user enters.
Dialog Forms Called
None
File Name
Syntax
ParseArgs(VAL Args: LIST OF STRING, REF Parms: LIST OF STRING, REF Values: LIST OF STRING ): STRING
Parameters
Args - list of command line arguments
Parms - a list of single character parameters
Values - a list of the values for each parameter
Returns
Returns a null string if successful, an error message
otherwise.
Side Effects
None
Description
This function parses the parameters passed on the command line and returns a list of parameters (parms) along with a list of values (values).
Dialog Forms Called
None
File Name
Syntax
ParseCoreParameters ( VAL cmdArgs: LIST OF STRING, REF args: LIST OF CoreParameterRec );
Parameters
cmdArgs - list of command switches that have been passed on the command line. There is one switch per string.
args - list of parameter values that stores the parsed values from the cmdArgs parameter
Returns
Nothing
Side Effects
None
Description
This function divides a list of command switches and stores each switch as a separate member in the args record list. Each paramter that is parsed has two parts, the argument name and an optional value.
Dialog Forms Called
None
File Name
Syntax
SAI_Logon ( VAL cmdLine: LIST OF STRING, REF user: UserEventRecord, VAL ext: BOOLEAN, VAL title: STRING ): BOOLEAN
Parameters
cmdLine - list of command line values entered by the user. Each value is represented by a single element in the list.
user - record used to hold the user specific information for the person logging on. This record is populated based on the values entered into the login screen.
ext - Boolean specifying whether this login should try to connect automatically before showing the login screen. This value typically is TRUE when used by external processes such as the monitors or Interface Designer
title - title for the logon dialog box
Returns
TRUE - The logon was valid. Any user specific information
is stored in the UserEventRecord reference paramter.
FALSE - The logon was not valid. The user is denied a
connection to the database.
Side Effects
None
Description
This function is used as the univeral full user login for all TSD processes, monitors and application-specific tools. The whole process is dependant on building a QE-style connect string which uses any command-line arguments passed in. After the connect string is constructed, then it is used to try to make a connection to a database. If successful, it will return TRUE and any user-specific information related to the logged user. If not, it will return FALSE and refuse the connection.
Dialog Forms Called
c_login.dfc[tutoriallogonform]
c_login.dfc[logonform]