List of All Documentation Objects

List of All Documentation Objects

In the following section all documentation objects are displayed, DA-C context to which they correspond, and the corresponding data retrieving script generated by the Wizard for them.

Project

DA-C context

- root folder in the Project Manager Logical View.

Data retrieval
DGML script

GetProject (ProjectData) /* use ProjectData */

Retrieved data

TProject ProjectData See "TProject properties"

File: <file_name_string>

DA-C context

- file in the Project Explorer
- directory in the Project Explorer
- file in the Editor
- the pointer sits on the file name in the Editor ( include directive )

Data retrieval
DGML script

GetFile(FileData,<file_name_string>) /* use FileData */

Retrieved data

TFile FileData See "TFile properties"

All Project files

DA-C context

- the same as for File
- Root in EV or LV of the Project Explorer

Data retrieval
DGML script

GetAllFiles(FileDataCol)
for_each(FileData in FileDataCol)
  /* use FileData */
end_for

Retrieved data

TFile FileData See "TFile properties"

Directory: <directory_name_string>

DA-C context

- Directory in the Project Explorer

Data retrieval
DGML script

GetDirectory(DirectoryData, <directory_name_string>) /* use DirectoryData */

Retrieved data

TDirectory DirectoryData See "TDirectory properties"

Directory Subtree: <directory_name_string>

DA-C context

- Directory in the Project Explorer

Data retrieval
DGML script

GetDirectorySubtree(DirectoryDataCol, <directory_name_string>)
for_each(DirectoryData in DirectoryDataCol)
  /* use DirectoryData */
end_for

Retrieved data

TDirectory DirectoryData See "TDirectory properties"

<category> Messages

DA-C context

- the Message Logs

Data retrieval
DGML script

GetMessages(MessageDataCol, <category_string>)
for_each(MessageData in MessagesDataCol)
  /* use MessageData */
end_for

Retrieved data

TMessage MessageData See "TMessage properties"

Function: <function_name_string>

DA-C context

- Function in LV of the Project Explorer
- the pointer in the editor or Browser sits on the function name

Data retrieval
DGML script

GetFunction(FunctionData, <function_name_string>, <file_name_string>) /* use FunctionData */

Retrieved data

TFunction FunctionData See "TFunction Structure"

Global Functions

DA-C context

- the pointer sits on the function name in the Browse Global Functions window.

Data retrieval
DGML script

GetGlobalFunctions(FunctionDataCol)
for_each(FunctionData in FunctionDataCol)
  /* use FunctionData */
end_for

Retrieved data

TFunction FunctionData See "TFunction Structure"

Module Functions: <file_name_string>

DA-C context

- function in LV of the Project Manager
- the pointer sits on the function name in the editor or Browser.

Data retrieval
DGML script

GetModuleFunctions (FunctionDataCol, <file_name_string>)
for_each(FunctionData in FunctionDataCol)
  /* use FunctionData */
end_for

Retrieved data

TFunction FunctionData See "TFunction Structure"

Module Variables: <file_name_string>

DA-C context

- variable in LV
- the pointer sits on the variable name in the Editor.

Data retrieval
DGML script

GetModuleVariables (VariableDataCol, <file_name_string>)
for_each(VariableData in VariableDataCol)
  /* use VariableData */
end_for

Retrieved data

TSymbol VariableData See "TSymbol (Variable) properties"

Global Variables

DA-C context

- The Browse Global Variables window

Data retrieval
DGML script

GetGlobalVariables(VariableDataCol)
for_each(VariableData in VariableDataCol)
  /* use VariableData */
end_for

Retrieved data

TSymbol VariableData See "TSymbol (Variable) properties"

Module Constants: <file_name_string>

DA-C context

- constant in LV of the Project Explorer
- the pointer sits on the constant name in the Editor.

Data retrieval
DGML script

GetModuleConstants (ConstantDataCol, <file_name_string>)
for_each(ConstantData in ConstantDataCol)
  /* use ConstantData */
end_for

Retrieved data

TSymbol ConstantData See "TSymbol (Variable) properties"

Global Constants

DA-C context

- The browse Global Constants window

Data retrieval
DGML script

GetGlobalConstants(ConstantDataCol)
for_each(ConstantData in ConstantDataCol)
  /* use ConstantData */
end_for

Retrieved data

TSymbol ConstantData See "TSymbol (Constant) properties"

Module Types: <file_name_string>

DA-C context

- local type in LV of the Project Manager
- the pointer sits on the local type name in the Editor.

Data retrieval
DGML script

GetModuleTypes (TypeDataCol, <file_name_string>)for_each(TypeData in TypeDataCol)
  /* use TypeData */
end_for

Retrieved data

TSymbol TypeData See "TSymbol (Type) properties"

Global Types

DA-C context

- The Browse Global Types window

Data retrieval
DGML script

GetGlobalTypes(TypeDataCol)
for_each(TypeData in TypeDataCol)
  /* use TypeData */
end_for

Retrieved data

TSymbol TypeData See "TSymbol (Type) properties"

Module Macros: <file_name_string>

DA-C context

- local macro in LV of the Project Manager
- the pointer sits on the local macro name in the Editor.

Data retrieval
DGML script

GetModuleMacros (MacroDataCol, <file_name_string>)
for_each(MacroData in MacroDataCol)
  /* use MacroData */
end_for

Retrieved data

TSymbol MacroData See "TSymbol (Macro) properties"

Global Macros

DA-C context

- The Browse Global Macros window.

Data retrieval
DGML script

GetGlobalMacros(MacroDataCol)
for_each(MacroData in MacroDataCol)
  /* use MacroData */
end_for

Retrieved data

TSymbol MacroData See "TSymbol (Macro) properties"

Declarations of <symbol_name_string>

DA-C context

- The Browse Declarations window over a global or static (non-local) variable

Data retrieval
DGML script

GetDeclarations(DeclarationDataCol, <symbol_name_string>, <module_path_string>)
for_each(DeclarationData in DecalarationDataCol)
  /* use DeclarationData */
end_for

Retrieved data

TBrowse DeclarationData See "TBrowse properties"

Uses of <symbol_name_string>

DA-C context

The Browse Uses window.( for a global or a static symbol)

Data retrieval
DGML script

GetUses(UseDataCol, <symbol_name_string>, <module_path_string>)
for_each(UseData in UseDataCol)
  /* use UseData */
end_for

Retrieved data

TBrowse UseData See "TBrowse properties"

Uses of <symbol_name_string> from function <function_name_string>

DA-C context

The Browse Uses window (for a local symbol)

Data retrieval
DGML script

GetUsesInFunction(UseDataCol, <symbol_name_string>, <function_name_string>, <module_path_string>)
for_each(UseData in UseDataCol)
  /* use UseData */
end_for

Retrieved data

TBrowse UseData See "TBrowse properties"

Assignments of <symbol_name_string>

DA-C context

The Browse Assignments window.( for a global or a static symbol)

Data retrieval
DGML script

GetAssignments(AssignmentDataCol, <symbol_name_string>, <module_path_string>)
for_each(AssignmentData in AssignmentDataCol)
  /* use AssignmentData */
end_for

Retrieved data

TBrowse AssignmentData See "TBrowse properties"

Assignment of <symbol_name_string> from function <function_name_string>

DA-C context

The Browse Assignments window.( for a global or a static symbol)

Data retrieval
DGML script

GetAssignmentsInFunction(AssignmentDataCol, <symbol_name_string>, <function_name_string>, <module_path_string>)
for_each(AssignmentData in AssignmentDataCol)
  /* use AssignmentData */
end_for

Retrieved data

TBrowse AssignmentData See "TBrowse properties"

Calls to <function_name_string>

DA-C context

The Browse CallsTo window.

Data retrieval
DGML script

GetCallsTo(CallToDataCol, <function_name_string>, <module_path_string>)
for_each(CallToData in CallToDataCol)
  /* use CallToData */
end_for

Retrieved data

TBrowse CallToData See "TBrowse properties"

Calls Within <function_name_string>

DA-C context

The Browse CallsWithin window.

Data retrieval
DGML script

GetCallsWithin(CallWithinDataCol, <function_name_string>, <module_path_string>)
for_each(CallWithinData in CallWithinDataCol) CallWithinData
  /* print CallWithinData */
end_for

Retrieved data

TBrowse CallWithinData See "TBrowse properties"

Uses Within <function_name_string>

DA-C context

The Browse UsesWithin window

Data retrieval
DGML script

GetUsesWithin(UsesWithinData, <function_name_string>, <module_path_string>)
/* use UsesWithinData */

Retrieved data

TUsesWithin UsesWithinData See "TUsesWithin properties"

Group: <group_name_string>

DA-C context

The group in the Graph

Data retrieval
DGML script

GetGroup(GroupData, <group_name_string>) /* use GroupData */

Retrieved data

TGroup GroupData See "TGroup properties"

Group Tree: <group_name_string>

DA-C context

The group in the Graph

Data retrieval
DGML script

GetGroupsTree(GroupDataCol, <group_name_string>)
for_each(GroupData in GroupDataCol)
  /* use GroupData */
end_for

Retrieved data

TGroup GroupData See "TGroup properties"

All Project Groups

DA-C context

The group in the Graph

Data retrieval
DGML script

GetAllGroups(GroupDataCol)
for_each(GroupData in GroupDataCol)
  /* use GroupData */
end_for

Retrieved data

TGroup GroupData See "TGroup properties"

View: <view_name_string>

DA-C context

Graph over a specified view

Data retrieval
DGML script

GetView(ViewData, <view_name_string>) /* use ViewData */

Retrieved data

TView ViewData See "TView properties"

View Tree: <view_name_string>

DA-C context

Graph over a specified view

Data retrieval
DGML script

GetViewsTree(ViewDataCol, <view_name_string>)
for_each(ViewData in ViewDataCol)
  /* use ViewData */
end_for

Retrieved data

TView ViewData "TView properties"

All Project Views

DA-C context

Graph over a specified view

Data retrieval
DGML script

GetAllViews(ViewDataCol)
for_each(ViewData in ViewDataCol)
  /* use ViewData */
end_for

Retrieved data

TView ViewData "TView properties"

Search for: <phrase_string>

DA-C context

The Find all occurrences of <phrase_string> Browser has focus

Data retrieval
DGML script

Search(SearchData, <phrase_string>, <object_name_string>, <options_string>)
/* use FoundData */

Retrieved data

TSearch SearchData See "TSearch properties"

Flowchart of <function_name_string>

DA-C context

Flowchart

Data retrieval
DGML script

GetFlowChart(FlowChartImage, <function_name_string>, <module_path_string> <options_string>) /* use FlowChartImage */

Retrieved data

image FlowChartImage See "The image Directive"

Call Graph of <function_name_string>

DA-C context

Call graph

Data retrieval
DGML script

GetCallGraph(CallGraphImage, <function_name_string>, <module_path_string>, <used_view_string>, <options_string>) /* use CallGraphImage */

Retrieved data

image CallGraphImage See "The image Directive"

Type Graph of <type_name_string>

DA-C context

Type graph

Data retrieval
DGML script

GetTypeGraph(TypeGraphImage, <type_name_string>, <module_path_string>, "TYPE", <options_string>) /* use TypeGraphImage */

Retrieved data

image TypeGraphImage See "The image Directive"

Mixed Type Graph of : <type_name_string>

DA-C context

Mixed Type graph

Data retrieval
DGML script

GetTypeGraph(TypeGraphImage, <type_name_string>, <module_path_string>, "MIXED", <options_string>) /* use TypeGraphImage */

Retrieved data

image TypeGraphImage See "The image Directive"

Metrics Report For <object_name_string>

DA-C context

Metrics report

Data retrieval
DGML script

GetMetricsReport(MetricsImage, <template_name_string>, <object_type_string>,<object_name_string>, <options_string>) /* use MetricsImage */

Retrieved data

image MetricsImage See "The image Directive"

All Template Metrics Reports

DA-C context

Metrics report

Data retrieval
DGML script

GetAllMetricsReport(MetricsImageCol, <template_name_string>, <object_type_string>, <object_name_string>)
for_each(MetricsImage in MetricsImageCol)
  /* use MetricsImage */
end_for

Retrieved data

image MetricsImage See "The image Directive"

DA-C context	- root folder in the Project Manager Logical View.
Data retrieval DGML script	GetProject (ProjectData) /* use ProjectData */
Retrieved data	TProject ProjectData See "TProject properties"

DA-C context	- file in the Project Explorer - directory in the Project Explorer - file in the Editor - the pointer sits on the file name in the Editor ( include directive )
Data retrieval DGML script	GetFile(FileData,<file_name_string>) /* use FileData */
Retrieved data	TFile FileData See "TFile properties"

DA-C context	- the same as for File - Root in EV or LV of the Project Explorer
Data retrieval DGML script	GetAllFiles(FileDataCol) for_each(FileData in FileDataCol) /* use FileData */ end_for
Retrieved data	TFile FileData See "TFile properties"

DA-C context	- Directory in the Project Explorer
Data retrieval DGML script	GetDirectory(DirectoryData, <directory_name_string>) /* use DirectoryData */
Retrieved data	TDirectory DirectoryData See "TDirectory properties"

DA-C context	- the Message Logs
Data retrieval DGML script	GetMessages(MessageDataCol, <category_string>) for_each(MessageData in MessagesDataCol) /* use MessageData */ end_for
Retrieved data	TMessage MessageData See "TMessage properties"

DA-C context	- Function in LV of the Project Explorer - the pointer in the editor or Browser sits on the function name
Data retrieval DGML script	GetFunction(FunctionData, <function_name_string>, <file_name_string>) /* use FunctionData */
Retrieved data	TFunction FunctionData See "TFunction Structure"

DA-C context	- the pointer sits on the function name in the Browse Global Functions window.
Data retrieval DGML script	GetGlobalFunctions(FunctionDataCol) for_each(FunctionData in FunctionDataCol) /* use FunctionData */ end_for
Retrieved data	TFunction FunctionData See "TFunction Structure"

DA-C context	- function in LV of the Project Manager - the pointer sits on the function name in the editor or Browser.
Data retrieval DGML script	GetModuleFunctions (FunctionDataCol, <file_name_string>) for_each(FunctionData in FunctionDataCol) /* use FunctionData */ end_for
Retrieved data	TFunction FunctionData See "TFunction Structure"

DA-C context	- variable in LV - the pointer sits on the variable name in the Editor.
Data retrieval DGML script	GetModuleVariables (VariableDataCol, <file_name_string>) for_each(VariableData in VariableDataCol) /* use VariableData */ end_for
Retrieved data	TSymbol VariableData See "TSymbol (Variable) properties"

DA-C context	- The Browse Global Variables window
Data retrieval DGML script	GetGlobalVariables(VariableDataCol) for_each(VariableData in VariableDataCol) /* use VariableData */ end_for
Retrieved data	TSymbol VariableData See "TSymbol (Variable) properties"

DA-C context	- constant in LV of the Project Explorer - the pointer sits on the constant name in the Editor.
Data retrieval DGML script	GetModuleConstants (ConstantDataCol, <file_name_string>) for_each(ConstantData in ConstantDataCol) /* use ConstantData */ end_for
Retrieved data	TSymbol ConstantData See "TSymbol (Variable) properties"

DA-C context	- The browse Global Constants window
Data retrieval DGML script	GetGlobalConstants(ConstantDataCol) for_each(ConstantData in ConstantDataCol) /* use ConstantData */ end_for
Retrieved data	TSymbol ConstantData See "TSymbol (Constant) properties"

DA-C context	- local type in LV of the Project Manager - the pointer sits on the local type name in the Editor.
Data retrieval DGML script	GetModuleTypes (TypeDataCol, <file_name_string>)for_each(TypeData in TypeDataCol) /* use TypeData */ end_for
Retrieved data	TSymbol TypeData See "TSymbol (Type) properties"

DA-C context	- The Browse Global Types window
Data retrieval DGML script	GetGlobalTypes(TypeDataCol) for_each(TypeData in TypeDataCol) /* use TypeData */ end_for
Retrieved data	TSymbol TypeData See "TSymbol (Type) properties"

DA-C context	- local macro in LV of the Project Manager - the pointer sits on the local macro name in the Editor.
Data retrieval DGML script	GetModuleMacros (MacroDataCol, <file_name_string>) for_each(MacroData in MacroDataCol) /* use MacroData */ end_for
Retrieved data	TSymbol MacroData See "TSymbol (Macro) properties"

DA-C context	- The Browse Global Macros window.
Data retrieval DGML script	GetGlobalMacros(MacroDataCol) for_each(MacroData in MacroDataCol) /* use MacroData */ end_for
Retrieved data	TSymbol MacroData See "TSymbol (Macro) properties"

DA-C context	- The Browse Declarations window over a global or static (non-local) variable
Data retrieval DGML script	GetDeclarations(DeclarationDataCol, <symbol_name_string>, <module_path_string>) for_each(DeclarationData in DecalarationDataCol) /* use DeclarationData */ end_for
Retrieved data	TBrowse DeclarationData See "TBrowse properties"

DA-C context	The Browse Uses window.( for a global or a static symbol)
Data retrieval DGML script	GetUses(UseDataCol, <symbol_name_string>, <module_path_string>) for_each(UseData in UseDataCol) /* use UseData */ end_for
Retrieved data	TBrowse UseData See "TBrowse properties"

DA-C context	The Browse Uses window (for a local symbol)
Data retrieval DGML script	GetUsesInFunction(UseDataCol, <symbol_name_string>, <function_name_string>, <module_path_string>) for_each(UseData in UseDataCol) /* use UseData */ end_for
Retrieved data	TBrowse UseData See "TBrowse properties"

DA-C context	The Browse Assignments window.( for a global or a static symbol)
Data retrieval DGML script	GetAssignments(AssignmentDataCol, <symbol_name_string>, <module_path_string>) for_each(AssignmentData in AssignmentDataCol) /* use AssignmentData */ end_for
Retrieved data	TBrowse AssignmentData See "TBrowse properties"

DA-C context	The Browse CallsTo window.
Data retrieval DGML script	GetCallsTo(CallToDataCol, <function_name_string>, <module_path_string>) for_each(CallToData in CallToDataCol) /* use CallToData */ end_for
Retrieved data	TBrowse CallToData See "TBrowse properties"

DA-C context	The Browse CallsWithin window.
Data retrieval DGML script	GetCallsWithin(CallWithinDataCol, <function_name_string>, <module_path_string>) for_each(CallWithinData in CallWithinDataCol) CallWithinData /* print CallWithinData */ end_for
Retrieved data	TBrowse CallWithinData See "TBrowse properties"

DA-C context	The Browse UsesWithin window
Data retrieval DGML script	GetUsesWithin(UsesWithinData, <function_name_string>, <module_path_string>) /* use UsesWithinData */
Retrieved data	TUsesWithin UsesWithinData See "TUsesWithin properties"

DA-C context	The group in the Graph
Data retrieval DGML script	GetGroup(GroupData, <group_name_string>) /* use GroupData */
Retrieved data	TGroup GroupData See "TGroup properties"

DA-C context	Graph over a specified view
Data retrieval DGML script	GetView(ViewData, <view_name_string>) /* use ViewData */
Retrieved data	TView ViewData See "TView properties"

DA-C context	The Find all occurrences of <phrase_string> Browser has focus
Data retrieval DGML script	Search(SearchData, <phrase_string>, <object_name_string>, <options_string>) /* use FoundData */
Retrieved data	TSearch SearchData See "TSearch properties"

DA-C context	Flowchart
Data retrieval DGML script	GetFlowChart(FlowChartImage, <function_name_string>, <module_path_string> <options_string>) /* use FlowChartImage */
Retrieved data	image FlowChartImage See "The image Directive"

DA-C context	Call graph
Data retrieval DGML script	GetCallGraph(CallGraphImage, <function_name_string>, <module_path_string>, <used_view_string>, <options_string>) /* use CallGraphImage */
Retrieved data	image CallGraphImage See "The image Directive"

DA-C context	Type graph
Data retrieval DGML script	GetTypeGraph(TypeGraphImage, <type_name_string>, <module_path_string>, "TYPE", <options_string>) /* use TypeGraphImage */
Retrieved data	image TypeGraphImage See "The image Directive"

DA-C context	Mixed Type graph
Data retrieval DGML script	GetTypeGraph(TypeGraphImage, <type_name_string>, <module_path_string>, "MIXED", <options_string>) /* use TypeGraphImage */
Retrieved data	image TypeGraphImage See "The image Directive"