Functions for Generating Browser Reports

Functions for Generating Browser Reports

GetAssignments Function

GetAssignmentsInFunction Function

GetCallsTo Function

GetCallsWithin Function

GetDeclarations Function

GetUses Function

GetUsesInFunction Function

GetUsesWithin Function

Search Function

GetAssignments Function

The GetAssignments function locates all program lines in which the value of the specified global or static variable is defined.

Declaration:

GetAssignments( TCollection<TBrowse> AssignmentsData, string VariableName, string ModulePath )

Parameters:

AssignmentsData - variable in which the search results are stored,

VariableName - name of the variable whose assignments are searched for,

ModulePath - path of the module in which the specified variable is defined. If the variable specified is global, ModulePath can be an empty string - ""

Example:

#{ GetAssignments( AssignmentsData, "MaxV", "" ) }#

GetAssignmentsInFunction Function

The GetAssignmentsInFunction function locates all program lines within the function specified in which the value of the specified local variable is defined.

Declaration:

GetAssignmentsInFunction( TCollection<TBrowse> AssignmentsData, string VariableName, string FunctionName, string ModulePath )

Parameters:

AssignmentsData - variable in which the search results are stored,

VariableName - name of the variable whose assignments are searched for,

FunctionName - name of the function in which the variable is defined and within which the search is carried out (this argument is entered if value assignments to a local variable are searched for).

ModulePath - path of the module in which the function specified is defined. If the function specified is global, ModulePath can be an empty string - "".

Example:

#{ GetAssignmentsInFunction( AssignmentsData, "x", "Povrsina", "") }#

Note: VariableName marks a variable visible in the function assigned. Should there be more than one local variable with the name assigned in the function assigned, the name refers to the first defined variable with the name assigned.

GetCallsTo Function

The GetCallsTo function searches for all program lines in which the function assigned is called.

Declaration:

GetCallsTo( TCollection<TBrowse> CallsToData, string FunctionName, string ModulePath )

Parameters:

CallsToData - variable in which the search results are stored,

FunctionName - name of the function whose calls are searched for,

ModulePath - path of the module in which the function assigned is defined. If the function assigned is global, ModulePath can be an empty string - "".

Example:

#{ GetCallsTo( CallsToData, "Print", "" ) }#

GetCallsWithin Function

The GetCallsWithin function searches for all program lines within the function specified which contain function calls.

Declaration:

GetCallsWithin( TCollection<TBrowse> CallsWithinData, string FunctionName, string ModulePath )

Parameters:

CallsWithinData - variable in which the search results are stored,

FunctionName - name of the function within which the search is conducted,

ModulePath - path of the module in which the function specified is defined. If the function specified is global, ModulePath can be an empty string - "".

Example:

#{ GetCallsWithin( CallsWithinData, "Print", "" ) }#

GetDeclarations Function

The GetDeclarations function locates all declarations of the assigned global or static symbol.

Declaration:

GetDeclarations( TCollection<TBrowse> DeclarationsData, string SymbolName, string ModulePath )

Parameters:

DeclarationsData - variable in which the declarations found are stored,

SymbolName - name of the symbol whose declarations are searched for,

ModulePath - path of the module in which the symbol assigned is defined. If the symbol assigned is global, ModulePath can be an empty string - "".

Example:

#{ GetDeclarations( DeclarationsData, "MaxV", "" ) }#

GetUses Function

The GetUses function locates all program lines in which the symbol assigned is used.

Declaration:

GetUses( TCollection<TBrowse> UsesData, string SymbolName, string ModulePath)

Parameters:

UsesData - variable in which the located uses of the symbol assigned are stored,

SymbolName - name of the symbol whose uses are searched for,

ModulePath - path of the module in which the symbol assigned is defined. If the symbol assigned is global, ModulePath can be an empty string - "".

Example:

#{ GetUses( UsesData, "MaxV", "" ) }#

GetUsesInFunction Function

The GetUsesInFunction function locates all program lines within the function assigned in which the symbol specified is used.

Declaration:

GetUsesInFunction( TCollection<TBrowse> UsesData, string SymbolName, string FunctionName, string ModulePath )

Parameters:

UsesData - variable in which the located uses of the symbol assigned are stored,

SymbolName - name of the symbol whose uses are searched for,

FunctionName - name of the function in which the symbol is defined and within which the search is conducted (this argument is entered if uses of a local symbol are searched for).

ModulePath - path of the module in which the function assigned is defined. If the function assigned is global, ModulePath can be an empty string - "".

Example:

#{ GetUsesInFunction( UsesData, "x", "Surface", "") }#

GetUsesWithin Function

The GetUsesWithin function searches for all symbols used within the function assigned.

Declaration:

GetUsesWithin( TUsesWithin UsesWithinData, string FunctionName, string ModulePath)

Parameters:

UsesWithinData - variable in which the search results are stored,

FunctionName - name of the function within which the search is conducted,

ModulePath - path of the module in which the function assigned is defined. If the function assigned is global, ModulePath can be an empty string - "".

Example:

#{ GetUsesWithin( UsesWithinData, "Print", "" ) }#

Search Function

The Search function searches for all iterations of a word or phrase assigned in the directory or logical group specified or in the entire project.

Declaration:

Search( TSearch FoundData, string Phrase, string ObjectName, string Options )

Parameters:

FoundData - variable in which the search results are stored,

Phrase - phrase searched for,

ObjectName - name of the directory or logical group within which the search is conducted; this argument has the value "ALL" if the search is conducted in the entire project,

Options - an unreadable argument for the user, it contains the codes of options selected and file types in accordance with which the search in the FindAllOccurences dialog is conducted.

Example:

#{ Search( FoundData, "a?" , "MathFun" , "110011010111" ) }# #{ Search( FoundData, "a?" , "ALL" , "0001110101101" ) }#