Open a new branch in the debug output tree, should be called on any function's entry point or as introduction of a new debug section in the main program. The result must be stored and passed back to a subsequent (matching) call to the subroutine LogClose().
SYNTAX:
ostat% = LogOpen% (func$, file$)
INPUTS:
func$ (STRING)
- Recommended is the name of the current function or section in the main program, but as this is in general just a descriptive label for the logging output, you may write whatever seems appropriate for your needs.
file$ (STRING)
- Optional the name of the source file, which contains the function. Same as above, it's just a recommendation.
RESULT:
ostat% (INTEGER)
- This is a state value, which must be saved and later passed back to the matching call of the LogClose() subroutine.