File Name
Syntax
AkMatchesEvent(REF lst: LIST OF ExpandRec)
Parameters
lst - list of possible matches for the partial key entered in the field
Returns
None
Side Effects
None
Description
This routine presents a list of possible matches for the partial key entered in the field. When the user selects one, the dialog box is closed and the choice is sent back to the calling dialog box.
Dialog Forms Called
None
File Name
Syntax
CloseBsrDlg(REF BSR: HierarchyEventInstRec)
Parameters
BSR - the event handle instance data for hierarchy managers
Returns
None
Side Effects
None
Description
This function saves the window position of the dialog box. It also sets BSR data to Unknown if the dialog box was closed with a cancel.
Dialog Forms Called
None
File Name
Syntax
CompletePartialTreeAK(VAL w: WINDOW, REF oldAK: STRING, REF ContinueEdit: BOOLEAN, VAL table: STRING, VAL field: STRING,VAL nextField: STRING): INTEGER
Parameters
w - parent window handle for sending message back
oldAK - the previous value for this field
ContinueEdit - identifies whether a user selected to continue editing a field when matches are found based on partial key
table - table name for the object
field - name of the current field
nextField - name of the next field in tab order
Returns
None
Side Effects
None
Description
This routine auto completes a box when a user tabs out. The box should be one that uses a tree control to edit. (Asset Categories, Locations) If 1 match is found, then the field is set and match returned to the calling dialog. If 0 matches are found, then the user is given a warning and the option to continue editing the current field or to tab to the next field If many matches are found, then the user will be presented a list of the matches from which they can choose.
Dialog Forms Called
None
File Name
Syntax
EnableHierarchyButtons(VAL wHdl: WINDOW, VAL mode: STRING, VAL node: TREENODE)
Parameters
wHdl - the window handle of the calling dialog box
mode - the mode of the dialog
node - the node handle of the currently selected node
Returns
None
Side Effects
None
Description
This function enables, disables or hides the buttons based on whether a node is known and the mode of the dialog box. Also, the select button is disabled if the parent window to the dialog box is mainWindow.
Dialog Forms Called
None
File Name
Syntax
ExpandedAkMatchesEvent(REF lst: LIST OF ExpandRec)
Parameters
lst: list of possible matches for the partial key entered in the field
Returns
None
Side Effects
None
Description
This routine presents a list of possible matches for the partial key. It provides more information than the AkMatchesEvent. When the user selects a match, the dialog box closes and the choice is sent back to the calling dialog box.
Dialog Forms Called
None
File Name
Syntax
ExpandNode(REF node: TREENODE, REF thisNode: ExpandRec, VAL table: STRING, REF vlist: LIST OF ExpandRec, VAL whdl: WINDOW)
Parameters
node - the node handle for the currently selected node
thisNode - the data for the currently selected node
table - the table for the data that is currently being worked on
vlist - children nodes for the currently selected node
whdl - window handle of the calling dialog box
Returns
None
Side Effects
None
Description
Takes the current node and finds the children nodes. Then inserts the children nodes into the hierarchy manager. When multi-customer support is enabled, if the node is not supported for the current user, the node description is displayed so that the user understands it cannot be selected.
Dialog Forms Called
None
File Name
Syntax
FillRootOfTree(REF BSR: HierarchyEventInstRec)
Parameters
BSR - the event handle instance data for hierarchy managers
Returns
None
Side Effects
None
Description
This function finds the root nodes for the hierarchy manager and places it in the tree control.
Dialog Forms Called
None
File Name
Syntax
FilterPM_Objects(VAL wHdl: WINDOW, REF BSR: HierarchyEventInstRec)
Parameters
wHdl - the window handle of the calling dialog
BSR - the event handle instance record for the dialog
Returns
None
Side Effects
None
Description
This function places this asset's tree in the container. It filters out other assets that have containers.
Dialog Forms Called
None
File Name
Syntax
FindNodeOrganization(VAL wHdl: WINDOW, VAL table: STRING, VAL SelectedNode: TREENODE, VAL mode: STRING, REF orgDirection: Integer, REF orgBrDirection: Integer): LIST OF STRING
Parameters
wHdl - the window handle of the calling dialog
table - the table for the type of object for which the organization is being set
SelectedNode - the node handle for the currently selected node
mode - the action that is currently taking place
orgDirection - the old direction for ORGANIZATION
orgBrDirection - the old direction for BR_ORGANIZATION
Returns
String
Side Effects
ORGANIZATION and BR_ORGANIZATION direction may be reset if needed. They should be reset by the calling function after the organization that they are selecting is returned.
Description
When browsing organizations for locations, asset categories, connections, the organization that can be selected is limited to the organization of the parent and children nodes. This function determines which organizations can be selected and if necessary limits the selection to those organizations. If necessary, the ORGANIZATION direction and BR_ORGANIZATION direction is reset. The ORGANIZATION direction is key to multi-customer support and if reset, must be immediately reset after the organization is selected.
Dialog Forms Called
None
File Name
Syntax
GetChildren( VAL Tree: STRING, VAL Parent: STRING, REF ExpandList: LIST OF ExpandRec, VAL Level: INTEGER)
Parameters
Tree - the table for objects currently being edited
Parent - the identifer for the object
ExpandList - the list of children
Level - level for node
Returns
None
Side Effects
None
Description
This function recursively gets the children for "Parent" and returns then in ExpandList. The children retrieved go alway to the leaf nodes.
Dialog Forms Called
None
File Name
Syntax
HandleHierarchyDlgSelect(VAL FieldSelected: STRING, REF BSR: HierarchyEventInstRec)
Parameters
FieldSelected - button control selected on dialog box
BSR - event handler for hierarchy manager
Returns
None
Side Effects
None
Description
This function performs an action on the dialog box and modifies the data on BSR based on the box selected on the dialog box.
Dialog Forms Called
None
File Name
Syntax
HandleHierarchyMenuSelect(VAL MenuSelected: INTEGER, REF BSR: HierarchyEventInstRec)
Parameters
MenuSelected - menu item selected on dialog box
BSR - event handler for hierarchy manager
Returns
None
Side Effects
None
Description
This function performs an action on the dialog box and modifies the data on BSR based on the menu item selected on the dialog box.
Dialog Forms Called
None
File Name
Syntax
HandleHierarchyPrintSelect(VAL node: TREENODE, VAL wHdl: WINDOW, VAL title: STRING, VAL PrintInfo: LIST OF ScreenPrintRec)
Parameters
node - the node handle for the currently selected node
wHdl - window handle of the calling dialog
title - title for print results
PrintInfo - information to print
Returns
None
Side Effects
None
Description
This function prints the information in PrintInfo.
Dialog Forms Called
c_prnt.dfc[treeprintchoice]
File Name
Syntax
HandleLinkCopyCancel(REF BSR: HierarchyEventInstRec)
Parameters
BSR - event handler for hierarchy manager
Returns
None
Side Effects
None
Description
This function asks the user if they really want to cancel their current action (link, copy, paste or paste to root). If they do, then it places the dialog box in Edit mode and takes the current node and displays its information.
Dialog Forms Called
None
File Name
Syntax
HandleTreeAccept(REF BSR: HierarchyEventInstRec, VAL node: TREENODE): INTEGER
Parameters
BSR - event handler for hierarchy manager
node - the node handle for the currently selected node
Returns
None
Side Effects
None
Description
This function updates BSR bases on the accepted node. Also, the node's children are displayed and the details for the node are displayed.
Dialog Forms Called
None
File Name
Syntax
HandleTreeSelect(REF BSR: HierarchyEventInstRec, VAL node: TREENODE): INTEGER
Parameters
BSR - event handler for hierarchy manager
node - the node handle for the currently selected node
Returns
None
Side Effects
None
Description
This function updates BSR bases on the current selected node. If multi-customer support is enabled, then the buttons and menu items are enabled or disabled based on whether the current node is supported.
Dialog Forms Called
None
File Name
Syntax
InitializeBsrForm(REF BSR: HierarchyEventInstRec, VAL wHdl: WINDOW)
Parameters
BSR - the event handler's instance data
wHdl -the window handle of the calling dialog box
Returns
None
Side Effects
None
Description
This function initializes the hierarchy manager with data. It also calls other functions that enable, disable, or hide the menu items and buttons.
Dialog Forms Called
None
File Name
Syntax
NodeAEV(VAL BSR: HierarchyEventInstRec)
Parameters
BSR - the event handle instance record for the dialog box
Returns
None
Side Effects
None
Description
This function sends a message to all the relevant KB files to display the details of the current node.
Dialog Forms Called
None
File Name
Syntax
PageLoaded(REF PageList: LIST OF NBPageRec, VAL FormName: STRING): BOOLEAN
Parameters
PageList - the list of all the pages and whether they are loaded
FormName - the form name of the page that was just selected
Returns
TRUE if already loaded, FALSE if not
Side Effects
None
Description
This function determines if the data on this page has been loaded.
Dialog Forms Called
None
File Name
Syntax
PartialAK2PK(REF display: ExpandRec,VAL w: WINDOW,VAL table: STRING, VAL ak: STRING): INTEGER
Parameters
display - key and description information for a tree record
w - window handle for dialog box
table - table name for the object
ak - value user entered in the box
Returns
String
Side Effects
None
Description
This routine performs auto completion of the entry box when user tabs out. If one match is found, then the box is set and the match returned to the calling dialog box. If no matches are found, then the user is given a warning and the option to continue editing the current box or to tab to the next box.
Dialog Forms Called
tree.dfc[ak2pk]
File Name
Syntax
SetBrowserMenu(VAL wHdl: WINDOW, VAL table: STRING, VAL node: TREENODE, VAL mode: STRING, VAL hierarchyMenuList: LIST OF menuListRec)
Parameters
wHdl - the window handle of the calling dialog box
table - the table used by the object being edited
node - the node handle of the currently selected node
mode - the mode of the dialog box
hierarchyMenuList - the menu list on the dialog box
Returns
None
Side Effects
None
Description
This function enables or disables menu items based on whether TAM is installed, the mode of the dialog box, and if containers are being edited.
Dialog Forms Called
None
File Name
Syntax
SetPageLoadedFlag(REF PageList: LIST OF NBPageRec, VAL FormName: STRING): INTEGER
Parameters
PageList - the list of all the pages and whether they are loaded
FormName - the form name of the page that was just selected
Returns
0 if page not found and marked as loaded
Side Effects
None
Description
This function finds the page in the PageList and marks it as loaded.
Dialog Forms Called
None
File Name
Syntax
SetPasteMenuItems(VAL wHdl: WINDOW, VAL table: STRING, VAL PasteState: BOOLEAN, VAL PasteRootState: BOOLEAN, VAL hierarchyMenuList: LIST OF menuListRec)
Parameters
wHdl - the window handle of the calling dialog box
table - the table used by the object being edited
PasteState - the node handle of the currently selected node
PasteRootState - the mode of the dialog box
hierarchyMenuList - the menu list on the dialog box
Returns
None
Side Effects
None
Description
This function enables or disables the paste and paste to root menu items based on the object being edited. It also sets the state of the menu items as enabled or disabled based on pasteState and pasteRootState.
Dialog Forms Called
None