AutomationInterfaces CATScriptUtilities
Usage: you must use this class as is. You should never derive it.
public class CATScriptUtilities
Class to provide utility functions which simplify the use
of the scripting interfaces.
Method Index
- o
ExecuteScriptV6(CATIAdpPLMIdentificator&,CatScriptLibraryType,CATUnicodeString&,CATVariant&,CATUnicodeString&,CATVariant*,unsigned int)
- A short-cut method which runs a function written in a scripting language
synchronously.
- o
GetScriptErrorNotification()
- Returns the name of the event event notification sent whenever a script raises an error.
- o
GetScriptInterruptNotification()
- Returns the name of the event event notification sent whenever a script is interrupted.
- o
GetScriptStartNotification()
- Returns the name of the event notification sent whenever a script begins its execution.
- o
GetScriptStopNotification()
- Returns the name of the event event notification sent whenever a script stops its execution.
- o
IsMacroPlayerOn()
- Returns true if a macro is currently being replayed.
- o
IsMacroRecorderOn()
- Returns true if a macro is currently being recorded.
- o
SetAutomationErrorMessage(CATUnicodeString&)
- Sets a custom error message which will be caught by
the script engines and displayed in the UI as a
replacement of the default error message ("The method XXX has failed").
Methods
o ExecuteScriptV6
| public static ExecuteScriptV6( | | iPLMId, |
| | iType, |
| const | iProgramName, |
| | oResult, |
| const | iFunctionName | = "CATMain", |
| | iParams | = NULL, |
| | iParamCount | = 0) |
-
A short-cut method which runs a function written in a scripting language
synchronously. ExecuteScript will return only once the scripted function
has finished running.
- Parameters:
-
- iPLMId
- PLM identificator of a macro library, which can be retrieved from a database query.
- iLibraryType
- The type of the library
- iProgramName
- The name of the program in the library
- oResult
- The value returned by the function (if any)
- iFunctionName
- The name of the function to invoke
- iParameters
- An C++ array of parameters for the function
- iParamCount
- The size of the parameter array.
o GetScriptErrorNotification
| public static GetScriptErrorNotification( | ) |
-
Returns the name of the event event notification sent whenever a script raises an error.
o GetScriptInterruptNotification
| public static GetScriptInterruptNotification( | ) |
-
Returns the name of the event event notification sent whenever a script is interrupted.
o GetScriptStartNotification
| public static GetScriptStartNotification( | ) |
-
Returns the name of the event notification sent whenever a script begins its execution.
o GetScriptStopNotification
| public static GetScriptStopNotification( | ) |
-
Returns the name of the event event notification sent whenever a script stops its execution.
o IsMacroPlayerOn
| public static IsMacroPlayerOn( | ) |
-
Returns true if a macro is currently being replayed.
o IsMacroRecorderOn
| public static IsMacroRecorderOn( | ) |
-
Returns true if a macro is currently being recorded.
o SetAutomationErrorMessage
| public static SetAutomationErrorMessage( | const | iMessage) |
-
Sets a custom error message which will be caught by
the script engines and displayed in the UI as a
replacement of the default error message ("The method XXX has failed").
- Parameters:
-
- iMessage
- The error message to display
This object is included in the file: CATScriptUtilities.h
If needed, your Imakefile.mk should include the module: CATAutoItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.