<html> <head> <title>Interface XDebugging</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XDebugging-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">script</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">deprecated </td> <td width="50%" class="title">interface XDebugging</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>deprecated</i></dd> <dt><b>Description</b></dt> <dd>makes it possible to set breakpoints in an interpreter. </dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#setBreakPoint">setBreakPoint</a></td> <td class="imsum_right">returns the source code line where the breakpoint was set. </td> </tr> <tr> <td class="imsum_left"><a href="#clearAllBreakPoints">clearAllBreakPoints</a></td> <td class="imsum_right">clears all breakpoints in the module set by "setBreakPoint". </td> </tr> <tr> <td class="imsum_left"><a href="#eval">eval</a></td> <td class="imsum_right">Evaluates an expression. </td> </tr> <tr> <td class="imsum_left"><a href="#getStackTrace">getStackTrace</a></td> <td class="imsum_right">Returns the engine's stack trace of the current execute position. Line break is the delimiter. </td> </tr> <tr> <td class="imsum_left"><a href="#getContextInformation">getContextInformation</a></td> <td class="imsum_right">returns more detailed information about a specified stack frame. </td> </tr> <tr> <td class="imsum_left"><a href="#dumpVariable">dumpVariable</a></td> <td class="imsum_right">returns the value of the variable at the given stack position. </td> </tr> <tr> <td class="imsum_left"><a href="#setVariable">setVariable</a></td> <td class="imsum_right">sets the value of the specified variable within the specified stack frame. </td> </tr> <tr> <td class="imsum_left"><a href="#isVariable">isVariable</a></td> <td class="imsum_right">returns whether the given variable exists within the specified stack frame. </td> </tr> <tr> <td class="imsum_left"><a href="#stop">stop</a></td> <td class="imsum_right">stops the execution of the interpreter. </td> </tr> <tr> <td class="imsum_left"><a href="#stepOver">stepOver</a></td> <td class="imsum_right">executes the next and only the next statement. </td> </tr> <tr> <td class="imsum_left"><a href="#stepIn">stepIn</a></td> <td class="imsum_right">executes the next and only the next statement. </td> </tr> <tr> <td class="imsum_left"><a href="#stepOut">stepOut</a></td> <td class="imsum_right">executes the program until the next return from this stack frame. </td> </tr> <tr> <td class="imsum_left"><a href="#doContinue">doContinue</a></td> <td class="imsum_right">continues the program execution. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="setBreakPoint" class="membertitle">setBreakPoint</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>setBreakPoint</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aModuleName,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nSourceCodeLine,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bOn );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the source code line where the breakpoint was set. </dd> <dd><p>The value can differ from the parameter <var>nSourceCodeLine</var> when this is not a valid line to place it. -1 indicates that the breakpoint cannot be set at this position. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="clearAllBreakPoints" class="membertitle">clearAllBreakPoints</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>clearAllBreakPoints</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aModuleName );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>clears all breakpoints in the module set by "setBreakPoint". </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="eval" class="membertitle">eval</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>eval</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aSourceCode,</td> </tr> <tr> <td/><td valign="top">[in] short</td> <td valign="bottom"> nCallStackPos );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Evaluates an expression. </dd> <dt><b>Returns</b></dt> <dd>the value of the expression as string. </dd> <dt><b>Parameter CallStackPos</b></dt> <dd>Position in the call stack for which the expression should be evaluated. 0 is the top/actual position in the call in the call stack, 1 the next and so on. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getStackTrace" class="membertitle">getStackTrace</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< string ></td> </tr> <tr> <td valign="top"><b>getStackTrace</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the engine's stack trace of the current execute position. Line break is the delimiter. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getContextInformation" class="membertitle">getContextInformation</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="ContextInformation.html">ContextInformation</a></td> </tr> <tr> <td valign="top"><b>getContextInformation</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> nCallStackPos );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns more detailed information about a specified stack frame. </dd> <dt><b>Parameter nCallStackPos</b></dt> <dd>specifies the position in the call stack for the variables that should be delivered. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="dumpVariable" class="membertitle">dumpVariable</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>dumpVariable</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aVariableName,</td> </tr> <tr> <td/><td valign="top">[in] short</td> <td valign="bottom"> nCallStackPos );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the value of the variable at the given stack position. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setVariable" class="membertitle">setVariable</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setVariable</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aVariableName,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aValue,</td> </tr> <tr> <td/><td valign="top">[in] short</td> <td valign="bottom"> nCallStackPos );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the value of the specified variable within the specified stack frame. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isVariable" class="membertitle">isVariable</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>isVariable</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aVariableName,</td> </tr> <tr> <td/><td valign="top">[in] short</td> <td valign="bottom"> nCallStackPos );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns whether the given variable exists within the specified stack frame. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="stop" class="membertitle">stop</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>stop</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>stops the execution of the interpreter. </dd> <dd><p>To continue with the execution, call <method>XDebugging::doContinue</method>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="stepOver" class="membertitle">stepOver</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>stepOver</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>executes the next and only the next statement. </dd> <dd><p>If the next statement is a function call, the function is executed completely.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="stepIn" class="membertitle">stepIn</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>stepIn</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>executes the next and only the next statement. </dd> <dd><p>If the next statement is a function call, only the function entered.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="stepOut" class="membertitle">stepOut</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>stepOut</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>executes the program until the next return from this stack frame. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="doContinue" class="membertitle">doContinue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>doContinue</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>continues the program execution. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>