Function checkDialogInput As String

This function checks to make sure all the form values have been filled in correctly

function CreateAppMap ( applicationName  As  String, screenName  As  String, windowCaption  As  String, Optional logLevel  As  Variant, Optional outputPath  As  Variant ) As Integer

Process a screen of an application and generate the map for that screen

Function CreateAppMapDialog As Integer

Creates a GUI dialog that is used to control the application mapping process.

function createNewMapFile ( applicationName  As  String ) As Object

Creates a new Map DOM document with the core processing instructions and the map node with the application name.

Function ensureUniqueObjectName ( objectName  As  String ) As String

Make sure the friendly object name we’re about to use is unique.

Function getDateStamp As String

Returns a date/time stamp for the current time, like the standard ISO 8601 date/time format minus the timezone (CCYY-MM-DDTHH:MM:SS)

Function getDefaultMapPath As String

Gets the default map path, which is {SQA_DIR_PROJECT}\testdata\maps.

Function getMapFileAttributes ( mapFile  As  String ) As Integer

Returns the attributes for the given map file

Function getObjectCoordinates( recStr  As  String ) As Object

This function stores the coordinates of the object.

Function getObjectDetails( recStr  As  String, objectNode  As  Object ) As Integer

Get’s all the objects details that we want to save and stores them in to objectNode.

Function getObjectNameFromRecognition( recStr  As  String ) As String

This function will attempt to generate a user-friendly unique name for an object.

Function GetRecFromMap( screenName  As  String, objectName  As  String ) As String

Once a map has been loaded, this function is used to retrieve the recognition string for an object.

function getScreenNode ( screenName  As  String ) As Object

Returns a new empty screen map node for the current screen.

Sub initLogLevelNames

Initializes the LogLevelNames array

Sub LoadMap ( map  As  String, Optional logLevel  As  Variant )

Loads an application map DOM.

Sub logEntry ( logLevel  As  Integer, entry  As  String )

A simple logging funtion to log strings to the global LogFile.

Sub logToConsole ( logLevel  As  Integer, entry  As  String )

A simple logging funtion to log strings to the console.

function openMapFile ( mapFilePath  As  String, applicationName  As  String ) As Object

Open the map file given in the file name parameter and return it as an XMLDomDocument object.

Function processMapDialog ( objectID  As  String, action  As  Integer, extraInfo  As  Long ) As Integer

This is the callback function used to process the dialog generated by the CreateAppMapDialog function.

Function processObject ( recStr  as  String, parentNode  As  Object ) As Integer

This function is at the heart of the mapper.

function saveMapFile ( mapFilePath  As  String ) As Integer

Attempts to save the new map DOM to file on disk.

Function searchRecognitionForName ( recStr  As  String, elementRE  As  String ) As String

This helper function for getObjectNameFromRecognition performs the actual search of the recognition string for the elements that will be used to create the object name.

Function storeCDATAIntoNode ( nodeName  As  String, CDATA  As  String ) As Object

This function will create a new dom element (using the node name we supply).

Function storeObjectProperties ( recStr  As  String, objectNode  As  Object ) As Integer

Stores the objects properties (as returned by SQAGetPropertyNames) into the object node

Function storeTextIntoNode ( nodeName  As  String, data  As  String ) As Object

This function will create a new dom element (using the node name we supply).

Function stripParentFromChildInName( recStr  As  String ) As String

It happens sometimes that Robot finds a child with a Name property that looks like ‘Name=parentName.childName’.

Function takeSnapshot ( recStr  As  String, screenShotPath  As  String ) As Integer

Uses the Snapshot function defined in the QuickSnap library to take a snapshot of an application given the applications parent window rec string.