Category:&&Functions
Jump to navigation
Jump to search
| &&Function | Description |
|---|---|
| &&amDaemon | Returns a 1 if a Daemon tab contains the currently active code. Otherwise, the returned number is 0. |
| &&arg | Serves as a placeholder for a command argument within a macro (if used outside of a macro, an error is issued). |
| &&assertFailureCount | Returns a count of the number of times that the result of an assert command is a Failure. |
| &&assertStatus | Returns a string that contains a summary of the counts of assert command results. |
| &&assertSuccessCount | Returns a count of the number of times that the result of an assert macro command is a Success. |
| &&blackOrWhiteList | Tests 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. |
| &&buildNumber | Returns the number of the build of the Client from which the function is called. |
| &&concatenate | Concatenate and return the function's arguments. |
| &¤tPacFile | Returns the URL of the Proxy Auto Config (PAC) file in use, or it returns empty if no PAC file is in use. |
| &¤tRunningMacro | 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. |
| &¤tTitle | Returns the current title of the Client main window. |
| &&exists | Tests if a macro variable is defined. |
| &&fileExists | Returns 1 if the file identified by fileSpec exists, 0 if not. |
| &&getMainSearchInputArea | Returns the value specified in the search input area on the Client main window. |
| &&getScope | Returns the scope of the specified routine from the SOUL call stack, -1 if routine not found or we are not executing a program. |
| &&getVariableOrFieldInputArea | Returns the value specified in the Entity name input box. If the Client is in hide-lower mode, the function returns the value specified in the input box in the Status bar. |
| &&globalAssertFailureCount | Same as &&assertFailureCount except its scope is the entire Client session. |
| &&globalAssertStatus | Same as &&assertStatus except its scope is the entire Client session. |
| &&globalAssertSuccessCount | Same as &&assertSuccessCount except its scope is the entire Client session. |
| &&ieMode | Returns the current setting of the Client's IE Mode preference. |
| &&index | 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. |
| &&isWatched | 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. |
| &&isWindowOpen | Returns 1 if the window whose title is passed is open, 0 otherwise |
| &&length | Returns the length in characters of its string argument. |
| &&logFile | Returns the absolute Windows file path of the client log file (the log.txt file). |
| &&numberOfBreakpoints | Returns the number of breakpoints that are set in the current request, irrespective of the current executing position in the request. |
| &&numberOfLevels | Returns the number of code levels being debugged. The main program is one level, and each active daemon adds another level. |
| &&numberWatched | Returns the number of items that are currently being watched in the Watch Window. |
| &&originalTitle | Returns the default value of the title of the Client main window. |
| &&preference | Returns the value of the specified Client preference setting. |
| &&procName | Returns the name of the procedure that is being executed. |
| &&prompt | 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. |
| &"e | Returns its argument enclosed in double quotes. |
| &&scriptFolder | Returns the value of <scriptFolder> from debuggerConfig.xml. |
| &&searchResult | Returns the line number of the line that contained the found string, if the last Client search operation successfully found something. |
| &&searchSuccess | 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). |
| &&selectedTab | Returns the label of the Client main window tab that is currently active. Or, it returns a null string () if no tab is active |
| &&stateFileFolder | Returns the location of all "state" files such as the log and saved preferences and window positions. |
| &&statusMessage | Returns the most recent Client status message. |
| &&substring | Return a substring of the target string argument. |
| &&sum | Returns the sum of the function arguments. |
| &&verifyMatch | Returns the 1-based position (in string) of the first character in string that is also in the characters in charSet. |
| &&verifyNoMatch | 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. |
| &&windowStatus | Returns 1 if the named window is open, 0 otherwise. |
This category currently contains no pages or media.