Difference between revisions of "Core.Terms.GetStackTrace"

From emotive
Jump to navigation Jump to search
(Created page with "Category:Core == Classification == {{ClassificationActivity | GetStackTrace | Return the procedure call stack for a given exception. | Term | OTX Core library...")
 
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Core]]
+
{{DISPLAYTITLE:OTX '''GetStackTrace'''}}[[Category:Core]]
 
== Classification ==
 
== Classification ==
 
{{ClassificationActivity | GetStackTrace | Return the procedure call stack for a given exception. | [[Term]] | [[Core|OTX Core library]] | [[Exception related terms]] | - | - }}
 
{{ClassificationActivity | GetStackTrace | Return the procedure call stack for a given exception. | [[Term]] | [[Core|OTX Core library]] | [[Exception related terms]] | - | - }}
  
== Pseudo-Code Syntax ==
+
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
Value = GetStackTrace(ExceptionTerm)
+
ListTerm = GetStackTrace(ExceptionTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 13: Line 13:
 
{{Important|Please keep in mind that this [[TermActivity]] in the form of an activity exists and no text can be entered. According to the respective [[ActionNode]] can further properties are added.}}
 
{{Important|Please keep in mind that this [[TermActivity]] in the form of an activity exists and no text can be entered. According to the respective [[ActionNode]] can further properties are added.}}
  
{{TermReturnValue| [[List]] | The procedure call stack for a given exception}}
+
{{TermReturnValue| [[Core.DataTypes.ComplexDataType.ContainerDataType.List|List]] | The procedure call stack for a given exception}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| ExceptionTerm | [[Exception]] | [[Term]] | - | [1] | Exception}}
+
{{TableRowPropertie1| ExceptionTerm | [[Core.Actions.Throw.Exception|Exception]] | [[Term]] | - | [1] | Exception}}
 
|}
 
|}
  
 
== Examples ==
 
== Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
List<String> result = GetStackTrace(exceptionVariable)
+
Exception exceptionVariable;
 +
String result;
 +
List<Integer> List1;
 +
List<String> List2;
 +
 
 +
try
 +
{
 +
  ListInsertItems(List1, 1, {1});
 +
}
 +
catch (Exception exceptionVariable)
 +
{
 +
}
 +
 
 +
List2 = GetStackTrace(exceptionVariable);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
[[GetExceptionOriginatorNode]] <br/>
+
[[Core.Terms.GetExceptionOriginatorNode|GetExceptionOriginatorNode]] <br/>
[[GetExceptionQualifier]] <br/>
+
[[Core.Terms.GetExceptionQualifier|GetExceptionQualifier]] <br/>
[[GetExceptionText]]
+
[[Core.Terms.GetExceptionText|GetExceptionText]]

Latest revision as of 09:04, 17 February 2016

Classification

Name GetStackTrace
Short Description Return the procedure call stack for a given exception.
Class Term
Extension OTX Core library
Group Exception related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

ListTerm = GetStackTrace(ExceptionTerm);

Description

GetStackTrace is a ListTerm return the procedure call stack for a given exception. The call stack shall be determined when the exception is created, not when it is thrown. The returned list contain the fully qualified names ofthe invoked procedures, e.g. {"myCompany.otx. myProcedure", "myCompany.otx.main"}.

Exclamation.png Important: Please keep in mind that this TermActivity in the form of an activity exists and no text can be entered. According to the respective ActionNode can further properties are added.

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
List The procedure call stack for a given exception

Properties

Name Data Type Class Default Cardinality Description
ExceptionTerm Exception Term - [1] Exception

Examples

Exception exceptionVariable;
String result;
List<Integer> List1;
List<String> List2;

try
{
   ListInsertItems(List1, 1, {1});
}
catch (Exception exceptionVariable)
{
}

List2 = GetStackTrace(exceptionVariable);

See also

GetExceptionOriginatorNode
GetExceptionQualifier
GetExceptionText