Debugger &&functions: Difference between revisions

From m204wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
Line 10: Line 10:
<tr><td>[[&&assertStatus]]</td><td>Returns a string that contains a summary of the counts of [[Assert command|assert]] command results.</td></tr>
<tr><td>[[&&assertStatus]]</td><td>Returns a string that contains a summary of the counts of [[Assert command|assert]] command results.</td></tr>
<tr><td>[[&&assertSuccessCount]]</td><td>Returns a count of the number of times that the result of an [[Assert command|assert]] macro command is a Success.</td></tr>
<tr><td>[[&&assertSuccessCount]]</td><td>Returns a count of the number of times that the result of an [[Assert command|assert]] macro command is a Success.</td></tr>
<tr><td>[[&&blackOrWhiteList]]</td><td>Tests whether the Debugger is [[run_only_to_listed_procs.html#invoke_whitelist_processing|filtering]] the procedures you are going to debug, and if so, whether a Black List or White List is being used.</td></tr>
<tr><td>[[&&blackOrWhiteList]]</td><td>Tests whether the Debugger is [[Running only to listed procedures#Invoking White List or Black List processing|filtering]] the procedures you are going to debug, and if so, whether a Black List or White List is being used.</td></tr>
<tr><td>[[&&buildNumber]]</td><td>Returns the number of the build of the Client from which the function is called.</td></tr>
<tr><td>[[&&buildNumber]]</td><td>Returns the number of the build of the Client from which the function is called.</td></tr>
<tr><td>[[&&concatenate]]</td><td>Concatenate and return the function's arguments.</td></tr>
<tr><td>[[&&currentPacFile]]</td><td>Returns the URL of the Proxy Auto Config (PAC) file in use, or it returns empty if no PAC file is in use.</td></tr>
<tr><td>[[&&currentPacFile]]</td><td>Returns the URL of the Proxy Auto Config (PAC) file in use, or it returns empty if no PAC file is in use.</td></tr>
<tr><td>[[&&currentRunningMacro]]</td><td>Returns the full file-system path to the macro within which it is called. If not called from within a macro, the function returns a null string.</td></tr>
<tr><td>[[&&currentRunningMacro]]</td><td>Returns the full file-system path to the macro within which it is called. If not called from within a macro, the function returns a null string.</td></tr>
<tr><td>[[&&currentTitle]]</td><td>Returns the current title of the Client main window.</td></tr>
<tr><td>[[&&currentTitle]]</td><td>Returns the current title of the Client main window.</td></tr>
<tr><td>[[&&exists]]</td><td>Tests if a [[working_with_macro_variables.html|macro variable]] is defined.</td></tr>
<tr><td>[[&&exists]]</td><td>Tests if a [[Working with macro variables|macro variable]] is defined.</td></tr>
<tr><td>[[&&fileExists]]</td><td>Returns 1 if the file identified by fileSpec exists, 0 if not. </td></tr>
<tr><td>[[&&fileExists]]</td><td>Returns 1 if the file identified by fileSpec exists, 0 if not. </td></tr>
<tr><td>[[&&getMainSearchInputArea]]</td><td>Returns the value specified in the [[search_facility.html|search]] input area on the Client main window.</td></tr>
<tr><td>[[&&getMainSearchInputArea]]</td><td>Returns the value specified in the [[Search facility|search]] input area on the Client main window.</td></tr>
<tr><td>[[&&getScope]]</td><td>Returns the scope of the specified routine from the SOUL call stack, -1 if routine not found or we are not executing a program.</td></tr>
<tr><td>[[&&getScope]]</td><td>Returns the scope of the specified routine from the SOUL call stack, -1 if routine not found or we are not executing a program.</td></tr>
<tr><td>[[&&globalAssertFailureCount]]</td><td>Same as [[&&assertFailureCount]] except its scope is the entire Client session.</td></tr>
<tr><td>[[&&globalAssertFailureCount]]</td><td>Same as [[&&assertFailureCount]] except its scope is the entire Client session.</td></tr>
<tr><td>[[&&globalAssertStatus]]</td><td>Same as [[&&assertStatus]] except its scope is the entire Client session.</td></tr>
<tr><td>[[&&globalAssertStatus]]</td><td>Same as [[&&assertStatus]] except its scope is the entire Client session.</td></tr>
<tr><td>[[&&globalAssertSuccessCount]]</td><td>Same as [[&&assertSuccessCount]] except its scope is the entire Client session.</td></tr>
<tr><td>[[&&globalAssertSuccessCount]]</td><td>Same as [[&&assertSuccessCount]] except its scope is the entire Client session.</td></tr>
<tr><td>[[&&ieMode function]]</td><td>Returns the current setting of the Client's [[file_menu_opts.html#ie_options|IE Mode preference.]]</td></tr>
<tr><td>[[&&ieMode function]]</td><td>Returns the current setting of the Client's [[File menu options#IE Options:|IE Mode preference.]]</td></tr>
<tr><td>[[&&index]]</td><td>Returns the 1-based position of the needle argument within the haystack argument, or it returns 0 if the needle value is not found within the haystack value.</td></tr>
<tr><td>[[&&index]]</td><td>Returns the 1-based position of the needle argument within the haystack argument, or it returns 0 if the needle value is not found within the haystack value.</td></tr>
<tr><td>[[&&isWatched]]</td><td>Determines whether its argument is a variable that is currently specified in the Watch Window. If it is, &&isWatched returns 1<; if not, it returns 0.</td></tr>
<tr><td>[[&&isWatched]]</td><td>Determines whether its argument is a variable that is currently specified in the Watch Window. If it is, &&isWatched returns 1<; if not, it returns 0.</td></tr>
Line 30: Line 31:
<tr><td>[[&&numberOfBreakpoints]]</td><td>Returns the number of breakpoints that are set in the current request, irrespective of the current executing position in the request.</td></tr>
<tr><td>[[&&numberOfBreakpoints]]</td><td>Returns the number of breakpoints that are set in the current request, irrespective of the current executing position in the request.</td></tr>
<tr><td>[[&&numberOfLevels]]</td><td>Returns the number of code levels being debugged. The main program is one level, and each active daemon adds another level.</td></tr>
<tr><td>[[&&numberOfLevels]]</td><td>Returns the number of code levels being debugged. The main program is one level, and each active daemon adds another level.</td></tr>
<tr><td>[[&&numberWatched]]</td><td>Returns the number of items that are currently [[watching_variables.html|being watched]] in the Watch Window.</td></tr>
<tr><td>[[&&numberWatched]]</td><td>Returns the number of items that are currently [[Watching program data items|being watched]] in the Watch Window.</td></tr>
<tr><td>[[&&originalTitle]]</td><td>Returns the default value of the title of the Client main window.</td></tr>
<tr><td>[[&&originalTitle]]</td><td>Returns the default value of the title of the Client main window.</td></tr>
<tr><td>[[&&preference]]</td><td>Returns the value of the specified Client preference setting.</td></tr>
<tr><td>[[&&preference]]</td><td>Returns the value of the specified Client preference setting.</td></tr>
Line 36: Line 37:
<tr><td>[[&&prompt]]</td><td>Pauses a macro while you supply an argument value for a command that is specified within the macro, then continues running the macro using the supplied value for the command.</td></tr>
<tr><td>[[&&prompt]]</td><td>Pauses a macro while you supply an argument value for a command that is specified within the macro, then continues running the macro using the supplied value for the command.</td></tr>
<tr><td>[[&&quote]]</td><td>Returns its argument enclosed in double quotes.</td></tr>
<tr><td>[[&&quote]]</td><td>Returns its argument enclosed in double quotes.</td></tr>
<tr><td>[[&&scriptFolder]]</td><td>Returns the value of </span><span class="f_Para" style="font-family: 'Courier New',Courier,monospace;">[[customize_debugger_cfg_file.html#scriptfolder|&lt;scriptFolder&gt;]]</span> from debuggerConfig.xml.</td></tr>
<tr><td>[[&&scriptFolder]]</td><td>Returns the value of </span><span class="f_Para" style="font-family: 'Courier New',Courier,monospace;">[[Customize debuggerConfig file#Alternative locations for Client files|&lt;scriptFolder&gt;]]</span> from debuggerConfig.xml.</td></tr>
<tr><td>[[&&searchResult]]</td><td>Returns the line number of the line that contained the found string, if the last Client search operation successfully found something.</td></tr>
<tr><td>[[&&searchResult]]</td><td>Returns the line number of the line that contained the found string, if the last Client search operation successfully found something.</td></tr>
<tr><td>[[&&searchSuccess]]</td><td>Returns 1 (True) if the last Client search operation (invoked by button or command) successfully found something. If the last search found nothing, or if there was no prior search, &&searchSuccess returns 0 (False).</td></tr>
<tr><td>[[&&searchSuccess]]</td><td>Returns 1 (True) if the last Client search operation (invoked by button or command) successfully found something. If the last search found nothing, or if there was no prior search, &&searchSuccess returns 0 (False).</td></tr>
<tr><td>[[&&selectedTab]]</td><td>Returns the label of the Client main window tab that is currently active. Or, it returns a null string ('') if no tab is active</td></tr>
<tr><td>[[&&selectedTab]]</td><td>Returns the label of the Client main window tab that is currently active. Or, it returns a null string ('') if no tab is active</td></tr>
<tr><td>[[&&stateFileFolder]]</td><td>Returns the location of all "state" files such as the log and saved preferences and window positions.</td></tr>
<tr><td>[[&&stateFileFolder]]</td><td>Returns the location of all "state" files such as the log and saved preferences and window positions.</td></tr>
<tr><td>[[&&statusMessage]]</td><td>Returns the most recent Client [[glance_at_status_area.html|status]] message.</td></tr>
<tr><td>[[&&statusMessage]]</td><td>Returns the most recent Client [[Status bar|status]] message.</td></tr>
<tr><td>[[&&substring]]</td><td>Return a substring of the target ''string'' argument.</td></tr>
<tr><td>[[&&substring]]</td><td>Return a substring of the target ''string'' argument.</td></tr>
<tr><td>[[&&sum]]</td><td>Returns the sum of the function arguments.</td></tr>
<tr><td>[[&&sum]]</td><td>Returns the sum of the function arguments.</td></tr>
<tr><td>[[&&verifyMatch]]</td><td>Returns the 1-based position (in ''string'') of the first character in ''string'' that is also in the characters in ''charSet''.</td></tr>
<tr><td>[[&&verifyMatch]]</td><td>Returns the 1-based position (in ''string'') of the first character in ''string'' that is also in the characters in ''charSet''.</td></tr>
<tr><td>[[&&verifyNoMatch]]</td><td>Returns the 1-based position (in ''string'') of the first character in ''string'' that is '''''not''''' in the characters in ''charSet''. If no character in ''string'' is not in ''charSet'', returns 0.</td></tr>
<tr><td>[[&&verifyNoMatch]]</td><td>Returns the 1-based position (in ''string'') of the first character in ''string'' that is '''''not''''' in the characters in ''charSet''. If no character in ''string'' is not in ''charSet'', returns 0.</td></tr>
<tr><td>[[&&windowStatus]]</td><td>Returns 1 if the named window is [[open_external_window.html|open]], 0 otherwise. </td></tr>
<tr><td>[[&&windowStatus]]</td><td>Returns 1 if the named window is [[Opening an external window|open]], 0 otherwise. </td></tr>
<!--bypass FUNCHECK.WIKI-->
<!--bypass FUNCHECK.WIKI-->
</table>
</table>

Latest revision as of 21:30, 28 December 2022

&&FunctionDescription
&&amDaemonReturns a 1 if a Daemon tab contains the currently active code. Otherwise, the returned number is 0.
&&argServes as a placeholder for a command argument within a macro (if used outside of a macro, an error is issued).
&&assertFailureCountReturns a count of the number of times that the result of an assert command is a Failure.
&&assertStatusReturns a string that contains a summary of the counts of assert command results.
&&assertSuccessCountReturns a count of the number of times that the result of an assert macro command is a Success.
&&blackOrWhiteListTests whether the Debugger is filtering the procedures you are going to debug, and if so, whether a Black List or White List is being used.
&&buildNumberReturns the number of the build of the Client from which the function is called.
&&concatenateConcatenate and return the function's arguments.
&&currentPacFileReturns the URL of the Proxy Auto Config (PAC) file in use, or it returns empty if no PAC file is in use.
&&currentRunningMacroReturns the full file-system path to the macro within which it is called. If not called from within a macro, the function returns a null string.
&&currentTitleReturns the current title of the Client main window.
&&existsTests if a macro variable is defined.
&&fileExistsReturns 1 if the file identified by fileSpec exists, 0 if not.
&&getMainSearchInputAreaReturns the value specified in the search input area on the Client main window.
&&getScopeReturns the scope of the specified routine from the SOUL call stack, -1 if routine not found or we are not executing a program.
&&globalAssertFailureCountSame as &&assertFailureCount except its scope is the entire Client session.
&&globalAssertStatusSame as &&assertStatus except its scope is the entire Client session.
&&globalAssertSuccessCountSame as &&assertSuccessCount except its scope is the entire Client session.
&&ieMode functionReturns the current setting of the Client's IE Mode preference.
&&indexReturns the 1-based position of the needle argument within the haystack argument, or it returns 0 if the needle value is not found within the haystack value.
&&isWatchedDetermines whether its argument is a variable that is currently specified in the Watch Window. If it is, &&isWatched returns 1<; if not, it returns 0.
&&isWindowOpenReturns 1 if the window whose title is passed is open, 0 otherwise
&&lengthReturns the length in characters of its string argument.
&&logFileReturns the absolute Windows file path of the client log file (the log.txt file).
&&numberOfBreakpointsReturns the number of breakpoints that are set in the current request, irrespective of the current executing position in the request.
&&numberOfLevelsReturns the number of code levels being debugged. The main program is one level, and each active daemon adds another level.
&&numberWatchedReturns the number of items that are currently being watched in the Watch Window.
&&originalTitleReturns the default value of the title of the Client main window.
&&preferenceReturns the value of the specified Client preference setting.
&&procNameReturns the name of the procedure that is being executed.
&&promptPauses a macro while you supply an argument value for a command that is specified within the macro, then continues running the macro using the supplied value for the command.
&&quoteReturns its argument enclosed in double quotes.
&&scriptFolderReturns the value of <scriptFolder> from debuggerConfig.xml.
&&searchResultReturns the line number of the line that contained the found string, if the last Client search operation successfully found something.
&&searchSuccessReturns 1 (True) if the last Client search operation (invoked by button or command) successfully found something. If the last search found nothing, or if there was no prior search, &&searchSuccess returns 0 (False).
&&selectedTabReturns the label of the Client main window tab that is currently active. Or, it returns a null string () if no tab is active
&&stateFileFolderReturns the location of all "state" files such as the log and saved preferences and window positions.
&&statusMessageReturns the most recent Client status message.
&&substringReturn a substring of the target string argument.
&&sumReturns the sum of the function arguments.
&&verifyMatchReturns the 1-based position (in string) of the first character in string that is also in the characters in charSet.
&&verifyNoMatchReturns the 1-based position (in string) of the first character in string that is not in the characters in charSet. If no character in string is not in charSet, returns 0.
&&windowStatusReturns 1 if the named window is open, 0 otherwise.