ÿþ<HTML xmlns="http://www.w3.org/TR/REC-html40"> <HEAD> <TITLE>DDDriverCounterCommands</TITLE> <LINK rel="stylesheet" href="rrafs.css" type="text/css"/> </HEAD> <BODY> <DIV NAME="top" ID="top"> <H3>DDDriverCounterCommands</H3> <SMALL>Last Updated:<script language="JavaScript">document.write(document.lastModified)</script></SMALL> <BR/> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Driver Commands for the Cycle, Suite, and Step drivers </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p> This keyword library provides Driver Commands that can be used by all three DDE Drivers--CycleDriver, SuiteDriver, and StepDriver. That means they can be used in any keyword driven test tables regardless of the test tables level--Cycle, Suite, or Step.</p><p> Each different driver command has different parameters as described in its documentation. For reference, the first fields of ALL Driver Command test records are defined below:</p><dl><dd>Field #1</dd><dt>The "C" = DRIVER COMMAND record type specifier.</dt><dd>Field #2</dd><dt>The Driver Command keyword.</dt></dl><p> Example:</p><code>c , SetApplicationMap , "AppMap.map"</code><p> Driver Command parameters must be placed in the test record in the field position specified in the documentation. Some parameters are optional. However, the field associated with that parameter must be honored. If you wish to skip an optional parameter you must still provide an empty field for that parameter.</p><p> Example:</p><code>c, LaunchApplication, NOTEPAD, NOTEPAD.EXE, , , "AppMap.map"</code><p> The above example shows two optional fields after NOTEPAD.EXE which are given no value(skipped).</p><p> Note that the full availablility of all Driver Commands is now spread across several files. Together, all of these files provide all the Driver Commands available to the core framework.</p><dl><dd><a href="DDDriverCommands.htm" target="_blank">DDDriverCommands</a></dd><dt>Miscellaneous and often used Commands.</dt><dd><a href="DDDriverLogCommands.htm" target="_blank">DDDriverLogCommands</a></dd><dt>Commands focused on logging test execution.</dt><dd><a href="DDDriverFlowCommands.htm" target="_blank">DDDriverFlowCommands</a></dd><dt>Commands focused on Error Recovery and Flow Control.</dt><dd><a href="DDDriverCounterCommands.htm" target="_blank">DDDriverCounterCommands</a></dd><dt>Commands focused on status tracking.</dt><dd><a href="DDDriverDeprecatedCommands.htm" target="_blank">DDDriverDeprecatedCommands</a></dd><dt>Commands that are still provided for backward compatibility, but are no longer supported.</dt><dd><a href="DDDriverDebugCommands.htm" target="_blank">DDDriverDebugCommands</a></dd><dt>Commands focused on debugging test execution.</dt></dl></detailed_desc><BR/> </DIV> </DIV> <BR/> <DIV NAME="list" ID="list"> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <TABLE cellspacing="3" border="1" cellpadding="2"> <TR> <TD nowrap="true" width="27%"><A NAME='list_DeleteCounter' HREF='#detail_DeleteCounter' >DeleteCounter</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </TD> <TD> Delete any existing private counter with the provided counterID. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_LogCounterInfo' HREF='#detail_LogCounterInfo' >LogCounterInfo</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </TD> <TD> Log the specified counter's info in the active log(s) of the current Log Facility. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_ResetCounter' HREF='#detail_ResetCounter' >ResetCounter</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </TD> <TD> Create a new private counter or reset counts in an existing private counter. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_ResumeStatusCounts' HREF='#detail_ResumeStatusCounts' >ResumeStatusCounts</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </TD> <TD> Resume counting on ALL status counters--both public/global and private. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_SetCounterMode' HREF='#detail_SetCounterMode' >SetCounterMode</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </TD> <TD> Create a new private counter or modify the mode of an existing private counter. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_StartCounter' HREF='#detail_StartCounter' >StartCounter</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </TD> <TD> Create a new private counter or start an existing stopped private counter. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_StartCycle' HREF='#detail_StartCycle' >StartCycle</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </TD> <TD> Begin tracking status on a user-defined item.</TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_StartProcedure' HREF='#detail_StartProcedure' >StartProcedure</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </TD> <TD> Begin tracking status on a user-defined item.</TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_StartRequirement' HREF='#detail_StartRequirement' >StartRequirement</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </TD> <TD> Begin tracking status on a user-defined item.</TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_StartSuite' HREF='#detail_StartSuite' >StartSuite</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </TD> <TD> Begin tracking status on a user-defined item.</TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_StartTestcase' HREF='#detail_StartTestcase' >StartTestcase</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </TD> <TD> Begin tracking status on a user-defined TestCase.</TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_StopCounter' HREF='#detail_StopCounter' >StopCounter</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </TD> <TD> Create a new private counter or suspend counts in an existing private counter. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_StopCycle' HREF='#detail_StopCycle' >StopCycle</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </TD> <TD> Stop tracking status on a user-defined item.</TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_StopProcedure' HREF='#detail_StopProcedure' >StopProcedure</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </TD> <TD> Stop tracking status on a user-defined item.</TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_StopRequirement' HREF='#detail_StopRequirement' >StopRequirement</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </TD> <TD> Stop tracking status on a user-defined item.</TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_StopSuite' HREF='#detail_StopSuite' >StopSuite</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </TD> <TD> Stop tracking status on a user-defined item.</TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_StopTestcase' HREF='#detail_StopTestcase' >StopTestcase</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </TD> <TD> Stop tracking status on a user-defined TestCase.</TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_StoreCounterInfo' HREF='#detail_StoreCounterInfo' >StoreCounterInfo</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </TD> <TD> Store the current values of the named counter into unique DDVariables. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_SuspendStatusCounts' HREF='#detail_SuspendStatusCounts' >SuspendStatusCounts</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </TD> <TD> Suspend counting on ALL status counters--both public/global and private. </TD> </TR> </TABLE> <HR/> </DIV> <DIV NAME="detail" ID="detail"> <H3><A NAME='detail_DeleteCounter' />DDDriverCounterCommands::<BIG>DeleteCounter</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Delete any existing private counter with the provided counterID. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> If counterID identifies an existing counter, then delete it. <p>See <a href="ApplicationUtilities.htm" target="_blank">ApplicationUtilities</a> for more information on private counters.</p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>counterID</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> The unique name used to identify this private counter. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> These unique names are case-insensitive. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>Description</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Any additional information for deleting this counter.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C, DeleteCounter, "TestCase 124", "All done"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Delete the private counter called "TestCase 124". </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_LogCounterInfo' />DDDriverCounterCommands::<BIG>LogCounterInfo</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Log the specified counter's info in the active log(s) of the current Log Facility. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Extracts a snapshot of the specified private counter and outputs a small, embedded Status Report in the active logs of the current Log Facility. The Status Report will be identified by the name of the private counter. (Future) We will allow you to optionally specify a different Log Facility by name. </detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>counterID</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> The unique name used to identify this private counter. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> These unique names are case-insensitive. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>logName</B> = MainLog ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> (Future) The name of a Log Facility other than the "current" one. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> When suppport for named Log Facilities is provided you will be able to specify which of these you wish to receive the Status Report. </detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C, LogCounterInfo, "TestCase 124"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Create a Status Report section in active logs of the current Log Facility. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> This Status Report will be identified by the name of the private counter. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_ResetCounter' />DDDriverCounterCommands::<BIG>ResetCounter</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Create a new private counter or reset counts in an existing private counter. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p>If counterID is not already an active private counter, then this routine will create a new private counter with the provided counterID as its name. The counter will be enabled for counting of all status information at all test levels.</p><p>If counterID identifies an existing counter, then this routine will reset all its counts to zero(0).</p><p>See <a href="ApplicationUtilities.htm" target="_blank">ApplicationUtilities</a> for more information on private counters.</p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>counterID</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> The unique name used to identify this private counter. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> These unique names are case-insensitive. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>Description</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Any additional information for resetting this counter.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C, ResetCounter, "TestCase 124", "Zero all counts to retest"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Create and/or reset counts on a counter called "TestCase 124". </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> If the counter does not exist, create it and enable counting all status information. If the counter already exists, reset counts to zero(0). </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_ResumeStatusCounts' />DDDriverCounterCommands::<BIG>ResumeStatusCounts</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Resume counting on ALL status counters--both public/global and private. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Resume all status counting that is triggered via ApplicationUtilities. Only counters that are enabled--not independently "stopped"--will resume counting. Stopped counters are still stopped. <p>See <a href="ApplicationUtilities.htm" target="_blank">ApplicationUtilities</a> for more information on counters.</p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI>[ <B>Description</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Any additional information for resuming status counts.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>logName</B> = MainLog ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> (Future) The name of a Log Facility other than the "current" one. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> When suppport for named Log Facilities is provided you will be able to specify which of these you wish to receive the notice. </detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C, ResumeStatusCounts, "Done resetting the application"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Suspend all status counting--public and private. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_SetCounterMode' />DDDriverCounterCommands::<BIG>SetCounterMode</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Create a new private counter or modify the mode of an existing private counter. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p>If counterID is not already an active private counter, then this routine will create a new private counter with the provided counterID and counting mode.</p><p>If counterID identifies an existing counter, then this routine will modify the counting mode of the existing counter.</p><p>See <a href="ApplicationUtilities.htm#ausetstatuscountermode" target="_blank">AUSetStatusCounterMode</a> for more information on private counters.</p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>counterID</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> The unique name used to identify this private counter. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> These unique names are case-insensitive. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B>mode</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> The counting mode to use for the specified counter. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Currently supported modes are: <ul><li>"AllStatusInfo" or "1"</li><li>"StepTestsOnly" or "2"</li></ul> Consult <a href="ApplicationUtilities.htm#ausetstatuscountermode" target="_blank">AUSetStatusCounterMode</a> for more information on private counters. </detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C, SetCounterMode, "TestCase 124", "StepTestsOnly"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Create a new counter with the mode or modify the mode of an existing counter. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The "TestCase 124" counter will be created and/or modified to use the "StepTestsOnly" counting mode. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">C, SetCounterMode, "TestCase 124", "2"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Create a new counter with the mode or modify the mode of an existing counter. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The "TestCase 124" counter will be created and/or modified to use the "StepTestsOnly" counting mode. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_StartCounter' />DDDriverCounterCommands::<BIG>StartCounter</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Create a new private counter or start an existing stopped private counter. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p>If counterID is not already an active private counter, then this routine will create a new private counter with the provided counterID as its name. The counter will be enabled for counting of all status information at all test levels.</p><p>If counterID identifies an existing counter, then this routine will enable the counter to resume counting--assuming it was stopped.</p><p>See <a href="ApplicationUtilities.htm" target="_blank">ApplicationUtilities</a> for more information on private counters.</p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>counterID</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> The unique name used to identify this private counter. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> These unique names are case-insensitive. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>Description</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Any additional information such as the purpose of the counter.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C, StartCounter, "TestCase 124", "Verify we can login."</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Create and/or (re)start a counter called "TestCase 124". </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> If the counter does not exist, create it and begin counting all status information. If the counter already exists, enable the counter to resume counting. This latter assumes the counter was previously stopped. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_StartCycle' />DDDriverCounterCommands::<BIG>StartCycle</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Begin tracking status on a user-defined item.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Log/process the beginning of testing associated with this user-defined item. A <a href="ApplicationUtilities.htm#austartstatuscounter" target="_blank">private counter</a> will keep track of status for the item. </detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>CycleID</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> The user-defined ID of the item.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>Description</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A description of the item.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C StartCycle Option1</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Logs the start of testing on an item with an ID of Option1. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The private status counter is also started. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">C StartCycle Option1 "Integration Testing"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Logs the start of testing on an item with an ID of Option1. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The private status counter is also started. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_StartProcedure' />DDDriverCounterCommands::<BIG>StartProcedure</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Begin tracking status on a user-defined item.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Log/process the beginning of testing associated with this user-defined item. A <a href="ApplicationUtilities.htm#austartstatuscounter" target="_blank">private counter</a> will keep track of status for the item. </detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>ProcedureID</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> The user-defined ID of the item.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>Description</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A description of the item.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C StartProcedure Option1</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Logs the start of testing on an item with an ID of Option1. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The private status counter is also started. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">C StartProcedure Option1 "Entering New Users"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Logs the start of testing on an item with an ID of Option1. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The private status counter is also started. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_StartRequirement' />DDDriverCounterCommands::<BIG>StartRequirement</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Begin tracking status on a user-defined item.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Log/process the beginning of testing associated with this user-defined item. A <a href="ApplicationUtilities.htm#austartstatuscounter" target="_blank">private counter</a> will keep track of status for the item. </detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>RequirementID</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> The user-defined ID of the item.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>Description</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A description of the item.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C StartRequirement Option1</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Logs the start of testing on an item with an ID of Option1. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The private status counter is also started. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">C StartRequirement Option1 "It Must Compile"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Logs the start of testing on an item with an ID of Option1. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The private status counter is also started. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_StartSuite' />DDDriverCounterCommands::<BIG>StartSuite</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Begin tracking status on a user-defined item.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Log/process the beginning of testing associated with this user-defined item. A <a href="ApplicationUtilities.htm#austartstatuscounter" target="_blank">private counter</a> will keep track of status for the item. </detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>SuiteID</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> The user-defined ID of the item.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>Description</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A description of the item.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C StartSuite Option1</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Logs the start of testing on an item with an ID of Option1. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The private status counter is also started. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">C StartSuite Option1 "Data Testing"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Logs the start of testing on an item with an ID of Option1. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The private status counter is also started. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_StartTestcase' />DDDriverCounterCommands::<BIG>StartTestcase</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Begin tracking status on a user-defined TestCase.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Log/process the beginning of testing associated with a user-defined Testcase. A <a href="ApplicationUtilities.htm#austartstatuscounter" target="_blank">private counter</a> will keep track of status for the testcase. </detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>TestCaseID</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> The user-defined ID of the Testcase.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>Description</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A description of the Testcase</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C StartTestcase Option1</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Logs the start of a testcase with an ID of Option1. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The private status counter is also started. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">C StartTestcase Option1 "It Must Compile"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Logs the start of a testcase with an ID of Option1. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The private status counter is also started. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_StopCounter' />DDDriverCounterCommands::<BIG>StopCounter</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Create a new private counter or suspend counts in an existing private counter. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p>If counterID is not already an active private counter, then this routine will create a new private counter with the provided counterID as its name. The counter will be enabled for counting of all status information at all test levels but will be suspended from actually counting.</p><p>If counterID identifies an existing counter, then this routine will suspend counting within this counter.</p><p>See <a href="ApplicationUtilities.htm" target="_blank">ApplicationUtilities</a> for more information on private counters.</p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>counterID</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> The unique name used to identify this private counter. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> These unique names are case-insensitive. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>Description</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Any additional information for stopping this counter.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C, StopCounter, "TestCase 124", "Done testing Login"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Create and/or suspend counts on a counter called "TestCase 124". </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> If the counter does not exist, create it and enable counting all status information but suspend all counting. If the counter already exists, suspend counting within it. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_StopCycle' />DDDriverCounterCommands::<BIG>StopCycle</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Stop tracking status on a user-defined item.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Log/process the end of testing associated with a user-defined item. A <a href="ApplicationUtilities.htm#austopstatuscounter" target="_blank">private counter</a> will keep track of status for the item. </detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>CycleID</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> The user-defined ID of the item.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>Description</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A description of the item.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C StopCycle Option1</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Logs the end of testing on an item with an ID of Option1. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The private status counter is also stopped. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">C StopCycle Option1 "Integration Testing"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Logs the end of testing on an item with an ID of Option1. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The private status counter is also stopped. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_StopProcedure' />DDDriverCounterCommands::<BIG>StopProcedure</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Stop tracking status on a user-defined item.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Log/process the end of testing associated with a user-defined item. A <a href="ApplicationUtilities.htm#austopstatuscounter" target="_blank">private counter</a> will keep track of status for the item. </detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>ProcedureID</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> The user-defined ID of the item.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>Description</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A description of the item.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C StopProcedure Option1</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Logs the end of testing on an item with an ID of Option1. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The private status counter is also stopped. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">C StopProcedure Option1 "Entering New Users"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Logs the end of testing on an item with an ID of Option1. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The private status counter is also stopped. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_StopRequirement' />DDDriverCounterCommands::<BIG>StopRequirement</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Stop tracking status on a user-defined item.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Log/process the end of testing associated with a user-defined item. A <a href="ApplicationUtilities.htm#austopstatuscounter" target="_blank">private counter</a> will keep track of status for the item. </detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>RequirementID</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> The user-defined ID of the item.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>Description</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A description of the item.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C StopRequirement Option1</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Logs the end of testing on an item with an ID of Option1. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The private status counter is also stopped. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">C StopRequirement Option1 "It Must Compile"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Logs the end of testing on an item with an ID of Option1. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The private status counter is also stopped. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_StopSuite' />DDDriverCounterCommands::<BIG>StopSuite</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Stop tracking status on a user-defined item.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Log/process the end of testing associated with a user-defined item. A <a href="ApplicationUtilities.htm#austopstatuscounter" target="_blank">private counter</a> will keep track of status for the item. </detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>SuiteID</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> The user-defined ID of the item.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>Description</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A description of the item.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C StopSuite Option1</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Logs the end of testing on an item with an ID of Option1. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The private status counter is also stopped. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">C StopSuite Option1 "Data Tests"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Logs the end of testing on an item with an ID of Option1. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The private status counter is also stopped. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_StopTestcase' />DDDriverCounterCommands::<BIG>StopTestcase</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Stop tracking status on a user-defined TestCase.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Log/process the end of testing associated with a user-defined Testcase. A <a href="ApplicationUtilities.htm#austopstatuscounter" target="_blank">private counter</a> will keep track of status for the testcase. </detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>TestCaseID</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> The user-defined ID of the Testcase.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>Description</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A description of the Testcase</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C StopTestcase Option1</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Logs the end of a testcase with an ID of Option1. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The private status counter is also stopped. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">C StopTestcase Option1 "It Must Compile"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Logs the end of a testcase with an ID of Option1. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The private status counter is also stopped. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_StoreCounterInfo' />DDDriverCounterCommands::<BIG>StoreCounterInfo</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Store the current values of the named counter into unique DDVariables. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> This enables the framework, scripts, and other applications to retrieve the values of these counters at runtime. <p>Consult <a href="ApplicationUtilities.htm#auvariablestorestatusinfo" target="_blank">ApplicationUtilities</a> and <a href="UsingDDVariables.htm" target="_blank">Using DDVariables</a> for more information on referencing these DDVariables in your tests.</p> You must adhere to DDVariable naming conventions when providing this DDVariable basename. Note that no spaces are allowed in DDVariable names. </detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>counterID</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> The unique name used to identify the private counter. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> These unique names are case-insensitive. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B>varPrefix</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> The unique DDVariable prefix to use for storing counter values. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The DDVariable prefix will be used to create several DDVariables that will hold the counter information. <ul>The variables stored:<br><li>VARPREFIX.successes</li><li>VARPREFIX.warnings</li><li>VARPREFIX.general_failures</li><li>VARPREFIX.test_passes</li><li>VARPREFIX.test_warnings</li><li>VARPREFIX.test_failures</li><li>VARPREFIX.test_records</li><li>VARPREFIX.total_records</li><li>VARPREFIX.IO_failures</li><li>VARPREFIX.skipped_records</li><li>VARPREFIX.filename</li><li>VARPREFIX.id</li><li>VARPREFIX.mode</li><li>VARPREFIX.suspended</li></ul><p>Consult <a href="ApplicationUtilities.htm#auvariablestorestatusinfo" target="_blank">ApplicationUtilities</a> and <a href="UsingDDVariables.htm" target="_blank">Using DDVariables</a> for more information on referencing these DDVariables in your tests.</p> You must adhere to DDVariable naming conventions when providing this DDVariable basename. Note that no spaces are allowed in DDVariable names. </detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C, StoreCounterInfo, ^counter="TestCase 124", ^varPrefix="TestCase124"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Store counter "TestCase 124" counts into several DDVariables prefixed with "TestCase124". </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p>Consult <a href="ApplicationUtilities.htm#auvariablestorestatusinfo" target="_blank">ApplicationUtilities</a> and <a href="UsingDDVariables.htm" target="_blank">Using DDVariables</a> for more information on referencing these DDVariables in your tests.</p> You must adhere to DDVariable naming conventions when providing this DDVariable basename. Note that no spaces are allowed in DDVariable names. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_SuspendStatusCounts' />DDDriverCounterCommands::<BIG>SuspendStatusCounts</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Suspend counting on ALL status counters--both public/global and private. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Suspends all status counting that is triggered via ApplicationUtilities. <p>See <a href="ApplicationUtilities.htm" target="_blank">ApplicationUtilities</a> for more information on counters.</p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI>[ <B>Description</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Any additional information for suspending status counts.</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>logName</B> = MainLog ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> (Future) The name of a Log Facility other than the "current" one. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> When suppport for named Log Facilities is provided you will be able to specify which of these you wish to receive the notice. </detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C, SuspendStatusCounts, "Resetting the application"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Suspend all status counting--public and private. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> </DIV> </BODY> </HTML>