Top Method Summary
Options Name Purpose
LONGCHAR BuildDiagram (character) Returns the Markdown document with the Mermaid diagram of the given container
DeleteDiagram (character, character) Deletes the diagram file of a container
CHARACTER GenerateDiagram (character) Generates the diagram file of the given container
CHARACTER GetDiagramFileName (character, character) Returns the name of the diagram file of a container


Method Detail
Top

LONGCHAR BuildDiagram (character)

Purpose: Returns the Markdown document with the Mermaid diagram of the
given container
Notes: Returns the unknown value when the Object Master does not exist
or is not a MetaForm or MetaControlGroup (or a sub type)

Parameters:
pcObjectMasterGuid CHARACTER
The ObjectMasterGuid of the container
Returns LONGCHAR
The Markdown document with the Mermaid diagram
Top

DeleteDiagram (character, character)

Purpose: Deletes the diagram file of a container
Notes: Used when a container is deleted, renamed or moved to another
product module. Does nothing when the file does not exist

Parameters:
pcObjectName CHARACTER
The object name of the container
pcModuleGuid CHARACTER
The GUID of the product module of the container
Top

CHARACTER GenerateDiagram (character)

Purpose: Generates the diagram file of the given container
Notes: The file is only written when its content has changed

Parameters:
pcObjectMasterGuid CHARACTER
The ObjectMasterGuid of the container
Returns CHARACTER
The name of the diagram file or the unknown value when no diagram was generated
Top

CHARACTER GetDiagramFileName (character, character)

Purpose: Returns the name of the diagram file of a container
Notes: <MermaidPath>/<ProductCode>/<ModuleName>/<ObjectName>.md

Parameters:
pcObjectName CHARACTER
The object name of the container
pcModuleGuid CHARACTER
The GUID of the product module of the container
Returns CHARACTER
The absolute file name or the unknown value when the diagram folder or the product module cannot be resolved


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       19.09.2026 10:14:14