Detailed Description
This class extends the CStatus object with additional error details if a Script Error has occured.
- Since:
- v5.0
- See also:
- Application::ExecuteScriptCode
#include <xsi_status.h>
Inheritance diagram for CScriptErrorDescriptor:
Public Member Functions | |
| CScriptErrorDescriptor (CStatus::Code in_code=OK) | |
| CScriptErrorDescriptor (LONG in_code) | |
| CString | GetDescription () const |
| ULONG | GetErrorLineNumber () const |
Constructor & Destructor Documentation
| CScriptErrorDescriptor | ( | CStatus::Code | in_code = OK | ) |
Constructs a CScriptErrorDescriptor based on one of the CStatus::Code values.
- Parameters:
-
in_code Error code to set
| CScriptErrorDescriptor | ( | LONG | in_code | ) |
Constructs a CScriptErrorDescriptor
- Parameters:
-
in_code Error number to set
Member Function Documentation
| CString GetDescription | ( | ) | const |
| ULONG GetErrorLineNumber | ( | ) | const |
Get the line number within the script that caused the script error. It will return 0 if no script error occurred.
- Returns:
- ULONG Line number, where the first line of a script is line zero
The documentation for this class was generated from the following file:
