Latest revision as of 13:54, 7 July 2015

The Runtime Test Services (declared in srtest.h) are a set of APIs in the Stride Runtime that facilitate the writing of target based test code. These APIs make up an optional portion of the Stride Runtime and can be used to communicate additional information about tests to the host based reporting mechanism. These APIs also allow target test code to create additional test suites and test cases dynamically at runtime.

There are two ways of accessing these APIs: through C-based functions, or through a C++ base class from which you may derive your C++ test class. These are discussed below in C Test Functions, and C++ Test Classes sections below.

C Test Functions

The following C APIs are provided:

srTestGetParam: returns an input parameters value.

srTestSuiteAddCase: creates an additional test case at runtime.
srTestSuiteAddAnnotation: creates a suite annotation at runtime.
srTestSuiteSetData: associates a custom name|value.

srTestCaseSetStatus: explicitly sets the status for the specified test case.
srTestCaseAddAnnotation: creates a test case annotation at runtime.
srTestSuiteSetData: associates a custom name|value pair with the specified test case.

srTestAnnotationAddComment: adds a comment to the specified annotation.

srTestGetParam

The srTestGetParam() function is used to get the value of a named parameter as a string.

srWORD srTestGetParam(const srCHAR * szName, srCHAR * szValue, srDWORD dwSize, const srCHAR * szDefValue);

Parameters	Type	Description
szName	Input	Pointer to a null-terminated string that represents the name of the parameter. Cannot be null.
szValue	Output	Pointer to a block of memory to store the value of the parameter with a maximum size of dwSize chars
dwSize	Input	Size in chars of the buffer pointed to by szValue
szDefValue	Input (optional)	Pointer to a null-terminated string that represents a default value in case the parameter is not specified. By setting this value to srNULL (or omitting it), you can use srTestGetParam() to test for the existence of a named parameter. If the named parameter doesn't exist, the function will return srERR_HANDLE_INVALID.

Return Value	Description
srOK	Success
srERR	Null or empty szName string passed in.
srERR_HANDLE_INVALID	The named parameter is not found and szDefValue is set to srNULL.

#include <srtest.h>

#define MAX_VALUE_LEN 128
void tfsuite_getParam(void)
{
  srCHAR szValue[MAX_VALUE_LEN] = {0};

  srWORD wRet = srTestGetParam("ParamName", szValue, MAX_VALUE_LEN, "default value");
}

#ifdef _SCL
#pragma scl_test_flist("testfunc", tfsuite_getParam)
#endif

srTestGetParamLong

The srTestGetParamLong() function is used to get the value of a named parameter as a long.

srLONG srTestGetParamLong(const srCHAR * szName, srLONG lDefValue);

Parameters	Type	Description
szName	Input	Pointer to a null-terminated string that represents the name of the parameter.
lDefValue	Input	Default value that is returned if the parameter is not found.

Return Value	Description
srLONG	Parameter value, or value specified by lDefValue if parameter isn't found.

#include <srtest.h>

void tfsuite_getParam(void)
{
  srLONG lVal = srTestGetParamLong("ParamName", -1);
}

#ifdef _SCL
#pragma scl_test_flist("testfunc", tfsuite_getParam)
#endif

srTestGetParamDouble

The srTestGetParamDouble() function is used to get the value of a named parameter as a double.

double srTestGetParamDouble(const srCHAR * szName, double dbDefValue);

Parameters	Type	Description
szName	Input	Pointer to a null-terminated string that represents the name of the parameter.
dbDefValue	Input	Default value that is returned if the parameter is not found.

Return Value	Description
double	Parameter value, or value specified by dbDefValue if parameter isn't found.

#include <srtest.h>

void tfsuite_getParam(void)
{
  double dbVal = srTestGetParamDouble("ParamName", 0.5772156649);
}

#ifdef _SCL
#pragma scl_test_flist("testfunc", tfsuite_getParam)
#endif

srTestSuiteAddCase

The srTestSuiteAddCase() routine is used to add a new test case to the specified test suite.

srTestCaseHandle_t srTestSuiteAddCase(const srCHAR * szName, const srCHAR * szDescr)

Parameters	Type	Description
szName	Input	Pointer to a null-terminated string that represents the name of the new test case. If null, the default host naming scheme will be used.
szDescr	Input	Pointer to a null-terminated string representing the description of the new test case. If null, description will be empty.

Return Value	Description
srTestCaseHandle_t	Handle of the newly created test case. srTEST_CASE_INVALID indicates failure to create a test case.

#include <srtest.h>
#include <stdio.h>

void tfsuite_addCase(void)
{
  for (int count = 0; count < 5; ++count)
  {
    char szName[25];
    sprintf(szName, "dynamic test case %d", count);
    srTestCaseHandle_t test = srTestSuiteAddCase(szName, "this is a dynamic test case");
    srTestCaseSetStatus(test, srTEST_PASS, 0); 
  }
}

#ifdef _SCL
#pragma scl_test_flist("testfunc", tfsuite_addCase)
#endif

srTestSuiteAddAnnotation

The srTestSuiteAddAnnotation() routine is used to add a new annotation to the specified test suite.

srTestAnnotationHandle_t srTestSuiteAddAnnotation(srTestAnnotationLevel_e eLevel,
                                                  const srCHAR * szName, 
                                                  const srCHAR * szFmtDescr, ...)

Parameters	Type	Description
eLevel	Input	Annotation level. srTEST_ANNOTATION_LEVEL_TRACE, srTEST_ANNOTATION_LEVEL_DEBUG, srTEST_ANNOTATION_LEVEL_INFO, srTEST_ANNOTATION_LEVEL_WARN, srTEST_ANNOTATION_LEVEL_ERROR, srTEST_ANNOTATION_LEVEL_FATAL
szName	Input	Pointer to a null-terminated string representing the name of the new annotation. If null, the default host naming scheme will be used.
szFmtDescr	Input	Pointer to a null-terminated string representing the description of the new annotation. Cannot be null.
...	Input (Optional)	Variable argument list to format szFmtDescr.

Return Value	Description
srTestAnnotationHandle_t	Handle of the newly created test annotation. srTEST_ANNOTATION_INVALID indicates failure to create a test annotation.

#include <srtest.h>

void tfsuite_addAnnotation(void) 
{
  for (int count = 0; count < 5; ++count)
  {
    char szName[25];
    sprintf(szName, "annotation %d", count);
    srTestAnnotationHandle_t annot = 
                     srTestSuiteAddAnnotation(srTEST_ANNOTATION_LEVEL_ERROR,
                                              szName,
                                              "description of annotation");
  }
}

#ifdef _SCL
#pragma scl_test_flist("testfunc", tfsuite_addAnnotation)
#endif

srTestSuiteSetData

The srTestSuiteSetData() routine is used to associate a custom name|value pair with a test suite.

srWORD srTestSuiteSetData(const srCHAR * szName, const srCHAR * szFmtValue, ...)

Parameters	Type	Description
szName	Input	Pointer to a null-terminated string representing the name of the custom pair. Cannot be null.
szFmtValue	Input	Pointer to a null-terminated string representing the value of the custom pair. Cannot be null.
...	Input (Optional)	Variable argument list to format szFmtValue.

Return Value	Description
srWORD	srOK on success, srERR_HANDLE_INVALID on invalid handle.

#include <srtest.h>

void tfcase_setData(void)
{
  srTestSuiteSetData("MyName", "my value");
}

#ifdef _SCL
#pragma scl_test_flist("testfunc", tfcase_setData)
#endif

srTestCaseSetStatus

The srTestCaseSetStatus() routine is used to set the result of test case.

srWORD srTestCaseSetStatus(srTestCaseHandle_t tTestCase, srTestStatus_e eStatus, srDWORD dwDuration)

Parameters	Type	Description
tTestCase	Input	Handle to a test case. srTEST_CASE_DEFAULT can be used for the default test case.
eStatus	Input	Result of the test. Possible values are: srTEST_FAIL srTEST_PASS srTEST_NOTINUSE srTEST_INPROGRESS srTEST_DONE - applicable to dynamic cases - sets the status to pass unless already set to fail or not-in-use
dwDuration	Input	The duration of the test in clock ticks. Using "0" allows the Stride Runtime (Intercept Module) to set the time automatically.

Return Value	Description
srWORD	srOK on success, srERR_HANDLE_INVALID on invalid handle.

#include <srtest.h>

void tfcase_setStatus(void)
{
  srTestCaseSetStatus(srTEST_CASE_DEFAULT, srTEST_PASS, 0);
}

#ifdef _SCL
#pragma scl_test_flist("testfunc", tfcase_setStatus)
#endif

srTestCaseSetStatusEx

The srTestCaseSetStatusEx() routine is used to set the result of test case and allow specification of an extendedFailureCode.

srWORD srTestCaseSetStatus(srTestCaseHandle_t tTestCase, srTestStatus_e eStatus, srDWORD dwDuration, srLONG lExtendedFailureCode)

Parameters	Type	Description
tTestCase	Input	Handle to a test case. srTEST_CASE_DEFAULT can be used for the default test case.
eStatus	Input	Result of the test.
dwDuration	Input	The duration of the test in clock ticks. Using "0" allows the Stride Runtime (Intercept Module) to set the time automatically.
lExtendedFailureCode	Input	The Stride framework uses the extendedFailureCode to capture the numeric results of test method when the test method fails via a numeric (non-void, nonbool) return type.

Return Value	Description
srWORD	srOK on success, srERR_HANDLE_INVALID on invalid handle.

#include <srtest.h>

void tfcase_setStatusEx(void)
{
  srTestCaseSetStatusEx(srTEST_CASE_DEFAULT, srTEST_FAIL, 0, -5);
}

#ifdef _SCL
#pragma scl_test_flist("testfunc", tfcase_setStatusEx)
#endif

srTestCaseAddAnnotation

The srTestCaseAddAnnotation() routine is used to add a new annotation to the specified test case.

srTestAnnotationHandle_t srTestCaseAddAnnotation(rTestCaseHandle_t tTestCase, srTestAnnotationLevel_e eLevel, const srCHAR * szName, const srCHAR * szFmtDescr, ...)

Parameters	Type	Description
tTestCase	Input	Handle to the parent test case to which new test annotation is to be added. srTEST_CASE_DEFAULT can be used for the default test case.
eLevel	Input	Annotation level. srTEST_ANNOTATION_LEVEL_TRACE, srTEST_ANNOTATION_LEVEL_DEBUG, srTEST_ANNOTATION_LEVEL_INFO, srTEST_ANNOTATION_LEVEL_WARN, srTEST_ANNOTATION_LEVEL_ERROR, srTEST_ANNOTATION_LEVEL_FATAL
szName	Input	Pointer to a null-terminated string representing the name of the new annotation. If null, the default host naming scheme will be used.
szFmtDescr	Input	Pointer to a null-terminated string representing the description of the new annotation. Cannot be null.
...	Input (Optional)	Variable argument list to format szFmtDescr.

Return Value	Description
srTestAnnotationHandle_t	Handle of the newly created test annotation. srTEST_ANNOTATION_INVALID indicates failure to create a test annotation.

#include <srtest.h>

void tfcase_addAnnotation(void) 
{
  for (int count = 0; count < 5; ++count)
  {
    char szName[25];
    sprintf(szName, "annotation %d", count);
    srTestAnnotationHandle_t annot = 
                     srTestCaseAddAnnotation(srTEST_CASE_DEFAULT,
                                             srTEST_ANNOTATION_LEVEL_ERROR,
                                             szName,
                                             "description of annotation");
  }
}

#ifdef _SCL
#pragma scl_test_flist("testfunc", tfcase_addAnnotation)
#endif

srTestCaseSetData

The srTestCaseSetData() routine is used to associate a custom name|value pair with a test case.

srWORD srTestCaseSetData(srTestCaseHandle_t tTestCase, const srCHAR * szName, const srCHAR * szFmtValue, ...);

Parameters	Type	Description
tTestCase	Input	Handle to a test case. srTEST_CASE_DEFAULT can be used for the default test case.
szName	Input	Pointer to a null-terminated string representing the name of the custom pair. Cannot be null.
szFmtValue	Input	Pointer to a null-terminated string representing the value of the custom pair. Cannot be null.
...	Input (Optional)	Variable argument list to format szFmtValue.

Return Value	Description
srWORD	srOK on success, srERR_HANDLE_INVALID on invalid handle.

#include <srtest.h>

void tfcase_setData(void)
{
  srTestCaseSetData(srTEST_CASE_DEFAULT, "MyName", "my value");
}

#ifdef _SCL
#pragma scl_test_flist("testfunc", tfcase_setData)
#endif

srTestAnnotationAddComment

The srTestAnnotationAddComment() routine is used to add a comment (aka a log) to a test annotation.

srWORD srTestAnnotationAddComment(srTestAnnotationHandle_t tTestAnnotation, const srCHAR * szLabel, const srCHAR * szFmtComment, ...)

Parameters	Type	Description
tTestAnnotation	Input	Handle to a test annotation.
szLabel	Input	Pointer to a null-terminated string for the label. If null, the default label will be applied.
szFmtComment	Input	Pointer to a null-terminated string representing the new comment. Cannot be null.
...	Input (Optional)	Variable argument list to format szFmtComment.

Return Value	Description
srWORD	srOK on success, srERR on null string or invalid formatted string, srERR_HANDLE_INVALID on invalid handle, srERR_STR_TRUNCATED on truncated string.

#include <srtest.h>

void tfsuiteAnnotation_addComment(void) 
{
  srTestAnnotationHandle_t annot = 
                           srTestSuiteAddAnnotation(srTEST_ANNOTATION_LEVEL_ERROR,
                                                    "annot",
                                                    "annot description");
  srTestAnnotationAddComment(annot,
                             srNULL,
                             "this comment should print %s", "A STRING");
}

#ifdef _SCL
#pragma scl_test_flist("testfunc", tfsuiteAnnotation_addComment)
#endif

C++ Test Classes

The Runtime Test Services C APIs work equally well from C test functions and C++ test classes. If, however, you are using C++ it might be more convinient for you to derive your C++ test classes from the Runtime Test Services C++ base class, srTest. That way you will have access to a set of simpler to use C++ classes.

The following C++ classes are provided:

class srTest - base test class
class srTestCase - represents a test case
class srTestAnnotation - represents a test annotation

class srTest

The srTest class provides one member object testCase of class srTestCase and the folowing methods:

method GetParam

This overload of the GetParam() method is used to get the value of a named parameter as a string.

static srWORD GetParam(const srCHAR * name, srCHAR * value, srDWORD size, const srCHAR * defval = srNULL)

Parameters	Type	Description
name	Input	Pointer to a null-terminated string that represents the name of the parameter. Cannot be null.
value	Output	Pointer to a block of memory to store the value of the parameter with a maximum size of size chars
size	Input	Size in chars of the buffer pointed to by value
defvalue	Input (optional)	Pointer to a null-terminated string that represents a default value in case the parameter is not specified. By setting this value to srNULL (or omitting it), you can use GetParam() to test for the existence of a named parameter. If the named parameter doesn't exist, the function will return srERR_HANDLE_INVALID.

Return Value	Description
srWORD	srOK on success, error otherwise.

#include <srtest.h>

class srtest_class : public stride::srTest
{
public:
  void getParam()
  {
    GetParam("ParamName", szValue, MAX_VALUE_LEN, "default value");
  }
};

#ifdef _SCL
#pragma scl_test_class(srtest_class)
#endif

method GetParam

This overload of the GetParam() method is used to get the value of a named parameter as a long.

static long GetParam(const srCHAR * name, srLONG defval = 0)

Parameters	Type	Description
name	Input	Pointer to a null-terminated string that represents the name of the parameter.
defvalue	Input	Default value that is returned if the parameter is not found.

Return Value	Description
srLONG	Parameter value, or value specified by defvalue if parameter isn't found.

#include <srtest.h>

class srtest_class : public stride::srTest
{
public:
  void getParam()
  {
    srLONG lValue = GetParam("ParamName", -1);
  }
};

#ifdef _SCL
#pragma scl_test_class(srtest_class)
#endif

method GetParam

This overload of the GetParam() method is used to get the value of a named parameter as a double.

static double GetParam(const srCHAR * name, const double& defval)

Parameters	Type	Description
name	Input	Pointer to a null-terminated string that represents the name of the parameter.
defvalue	Input	Default value that is returned if the parameter is not found.

Return Value	Description
double	Parameter value, or value specified by defvalue if parameter isn't found.

#include <srtest.h>

class srtest_class : public stride::srTest
{
public:
  void getParam()
  {
    double dbVal = GetParam("ParamName",  0.5772156649);
  }
};

#ifdef _SCL
#pragma scl_test_class(srtest_class)
#endif

method AddCase

The AddCase method is used to add a new test case to the test suite.

srTestCase AddCase(const srCHAR * name, const srCHAR * descr = srNULL)

Parameters	Type	Description
name	Input	Pointer to null-terminated string that represents the name of the new test case. If empty, the default host naming scheme will be used.
descr	Input (Optional)	Pointer to null-terminated string representing the description of the new test case. If empty, description will be blank.

Return Value	Description
srTestCase	Newly created test case instance.

Example

#include <srtest.h>
#include <sstream>

class srtest_class : public stride::srTest
{
public:
  void suiteAddSuite()
  {
    const std::string prefix("dynamic test case ");
    for (int count = 0; count < 5; ++count)
    {
      std::stringstream strm;
      strm << prefix << count;
      stride::srTestCase tc = AddCase(strm.str().c_str());
      tc.SetStatus(srTEST_PASS);
    }
  }
};

#ifdef _SCL
#pragma scl_test_class(srtest_class)
#endif

method AddAnnotation

The AddAnnotation method is used to add a new test annotation to the test suite.

srTestAnnotation AddAnnotation(srTestAnnotationLevel_e level, const srCHAR * name, const srCHAR * descr, ...)

Parameters	Type	Description
level	Input	Annotation level. srTEST_ANNOTATION_LEVEL_TRACE, srTEST_ANNOTATION_LEVEL_DEBUG, srTEST_ANNOTATION_LEVEL_INFO, srTEST_ANNOTATION_LEVEL_WARN, srTEST_ANNOTATION_LEVEL_ERROR, srTEST_ANNOTATION_LEVEL_FATAL
name	Input	Pointer to null-terminated string that represents the name of the new annotation. If empty, the default host naming scheme will be used.
descr	Input	Pointer to null-terminated string representing the description of the new annotation. Cannot be null.

Return Value	Description
srTestAnnotation	Newly created annotation instance.

#include <srtest.h>
#include <sstream>

class srtest_class : public stride::srTest
{
public:
  void suiteAddAnnotation()
  {
    for (int count = 0; count < 5; ++count)
    {
      std::stringstream strmName;
      std::stringstream strmDescr;
      strmName << "annotation " << count;
      strmDescr << "description of annotation " << count;
      stride::srTestAnnotation ta = AddAnnotation(srTEST_ANNOTATION_LEVEL_INFO,
                                                  strmName.str().c_str(),
                                                  strmDescr.str().c_str());
    }
  }
};

#ifdef _SCL
#pragma scl_test_class(srtest_class)
#endif

method SetData

The SetData method is used to associate a custom name|value pair with the test suite.

srWORD SetData(const srCHAR * name, const srCHAR * value, ...)

Parameters	Type	Description
name	Input	Pointer to a null-terminated string representing the name of the custom pair. Cannot be null.
value	Input	Pointer to a null-terminated string representing the value of the custom pair. Cannot be null.

Return Value	Description
srWORD	srOK on success, srERR_HANDLE_INVALID on invalid handle.

Example

#include <srtest.h>
#include <sstream>

class srtest_class : public stride::srTest
{
public:
  void suiteSetData()
  {
      SetData("MyName", "my value");
  }
};

#ifdef _SCL
#pragma scl_test_class(srtest_class)
#endif

class srTestCase

The srTestCase class provides the following methods:

method SetStatus

The SetStatus method is used to set the result of the default test case.

srWORD SetStatus(srTestStatus_e status, srDWORD duration = 0)

Parameters	Type	Description
status	Input	Result of the test. Possible values are: srTEST_FAIL srTEST_PASS srTEST_NOTINUSE srTEST_INPROGRESS srTEST_DONE - applicable to dynamic cases - sets the status to pass unless already set to fail or not-in-use
duration	Input (Optional)	The duration of the test in clock ticks. The default is 0.

Return Value	Description
srWORD	srOK on success, srERR_HANDLE_INVALID on invalid handle.

#include <srtest.h>

class srtest_class : public stride::srTest
{
public:
  void caseSetStatus()
  {
    testCase.SetStatus(srTEST_NOTINUSE);
  }
};

#ifdef _SCL
#pragma scl_test_class(srtest_class)
#endif

method AddAnnotation

The AddAnnotation method is used to add a new test annotation to the test case.

srTestAnnotation AddAnnotation(srTestAnnotationLevel_e level, const srCHAR * name, const srCHAR * descr, ...)

Parameters	Type	Description
level	Input	Annotation level. srTEST_ANNOTATION_LEVEL_TRACE, srTEST_ANNOTATION_LEVEL_DEBUG, srTEST_ANNOTATION_LEVEL_INFO, srTEST_ANNOTATION_LEVEL_WARN, srTEST_ANNOTATION_LEVEL_ERROR, srTEST_ANNOTATION_LEVEL_FATAL
name	Input	Pointer to null-terminated string that represents the name of the new annotation. If null, the default host naming scheme will be used.
descr	Input	Pointer to null-terminated string representing the description of the new annotation. Cannot be null.

Return Value	Description
srTestAnnotation	Newly created annotation instance.

#include <srtest.h>
#include <sstream>

class srtest_class : public stride::srTest
{
public:
  void caseAddAnnotation()
  {
    for (int count = 0; count < 5; ++count)
    {
      std::stringstream strmName;
      std::stringstream strmDescr;
      strmName << "annotation " << count;
      strmDescr << "description of annotation " << count;
      stride::srTestAnnotation ta = 
                 testCase.AddAnnotation(srTEST_ANNOTATION_LEVEL_INFO,
                                         strmName.str().c_str(),
                                         strmDescr.str().c_str());
    }
  }
};

#ifdef _SCL
#pragma scl_test_class(srtest_class)
#endif

method SetData

The SetData method is used to associate a custom name|value pair with the test case.

srWORD SetData(const srCHAR * name, const srCHAR * value, ...)

Parameters	Type	Description
name	Input	Pointer to a null-terminated string representing the name of the custom pair. Cannot be null.
value	Input	Pointer to a null-terminated string representing the value of the custom pair. Cannot be null.

Return Value	Description
srWORD	srOK on success, srERR_HANDLE_INVALID on invalid handle.

#include <srtest.h>

class srtest_class : public stride::srTest
{
public:
  void caseSetData()
  {
    testCase.SetData("MyName", "my value");
  }
};

#ifdef _SCL
#pragma scl_test_class(srtest_class)
#endif

class srTestAnnotation

The srTestAnnotation class provides the following methods:

method AddComment

The AddComment method is used to add a comment to the test annotation.

srWORD AddComment(const srCHAR * label, const srCHAR * comment, ...)

Parameters	Type	Description
label	Input	Pointer to null-terminated string for the label. If null, the default label will be applied.
comment	Input	Pointer to null-terminated string representing the new comment. Cannot be empty.

Return Value	Description
srWORD	srOK on success, srERR on null string or invalid formatted string, srERR_HANDLE_INVALID on invalid handle, srERR_STR_TRUNCATED on truncated string.

#include <srtest.h>

class srtest_class : public stride::srTest
{
public:
  void suiteAnnotationAddComment()
  {
    stride::srTestAnnotation ta = 
                 testSuite.AddAnnotation(srTEST_ANNOTATION_LEVEL_INFO,
                                         "annot",
                                         "annot description");
    ta.AddComment("this comment on annotation should print %s", "A STRING");
  }
};

#ifdef _SCL
#pragma scl_test_class(srtest_class)
#endif

Difference between revisions of "Runtime Test Services"

Latest revision as of 13:54, 7 July 2015

C Test Functions

srTestGetParam

srTestGetParamLong

srTestGetParamDouble

srTestSuiteAddCase

srTestSuiteAddAnnotation

srTestSuiteSetData

srTestCaseSetStatus

srTestCaseSetStatusEx

srTestCaseAddAnnotation

srTestCaseSetData

srTestAnnotationAddComment

C++ Test Classes

class srTest

method GetParam

method GetParam

method GetParam

method AddCase

method AddAnnotation

method SetData

class srTestCase

method SetStatus

method AddAnnotation

method SetData

class srTestAnnotation

method AddComment

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Tools

@@ Line 1: / Line 1: @@
-== Runtime Test Services  ==
+__NOTOC__
+The Runtime Test Services (declared in '''srtest.h''') are a set of APIs in the Stride Runtime that facilitate the writing of target based test code. These APIs make up an optional portion of the Stride Runtime and can be used to communicate additional information about tests to the host based reporting mechanism. These APIs also allow target test code to create additional test suites and test cases dynamically at runtime.
-The Runtime Test Services (declared in srtest.h) are a set of APIs in the STRIDE Runtime that facilitate the writing of target based test code. These APIs make up an optional portion of the STRIDE Runtime and can be used to communicate additional information about tests to the host based reporting mechanism. These APIs also allow target test code to create additional test suites and test cases dynamically at runtime.
 There are two ways of accessing these APIs: through C-based functions, or through a C++ base class from which you may derive your C++ test class. These are discussed below in [[#C Test Functions|C Test Functions]], and [[#C++ Test Classes|C++ Test Classes]] sections below.
-Refer to the [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]] or the [[Media:s2sRuntime.pdf|Runtime Developer's Guide]] for more detailed information about any of these APIs.
+= C Test Functions =
-=== C Test Functions ===
 The following C APIs are provided:
@@ Line 24: / Line 21: @@
-==C==
+== srTestGetParam ==
-==== srTestGetParam ====
 The srTestGetParam() function is used to get the value of a named parameter as a string.
 <source lang=c>
 srWORD srTestGetParam(const srCHAR * szName, srCHAR * szValue, srDWORD dwSize, const srCHAR * szDefValue);
 </source>
 {| border="1" cellspacing="0" cellpadding="10" style="align:left;"
@@ Line 67: / Line 63: @@
 | The named parameter is not found and <i>szDefValue</i> is set to srNULL.
 |}
 <source lang=c>
@@ Line 85: / Line 82: @@
-==== srTestGetParamLong ====
+== srTestGetParamLong ==
 The srTestGetParamLong() function is used to get the value of a named parameter as a long.
 <source lang=c>
 srLONG srTestGetParamLong(const srCHAR * szName, srLONG lDefValue);
 </source>
 {| border="1" cellspacing="0" cellpadding="10" style="align:left;"
@@ Line 112: / Line 110: @@
 | Parameter value, or value specified by <i>lDefValue</i> if parameter isn't found.
 |}
 <source lang=c>
@@ Line 126: / Line 125: @@
 </source>
-==== srTestGetParamDouble ====
+== srTestGetParamDouble ==
 The srTestGetParamDouble() function is used to get the value of a named parameter as a double.
 <source lang=c>
 double srTestGetParamDouble(const srCHAR * szName, double dbDefValue);
 </source>
 {| border="1" cellspacing="0" cellpadding="10" style="align:left;"
@@ Line 153: / Line 154: @@
 | Parameter value, or value specified by <i>dbDefValue</i> if parameter isn't found.
 |}
 <source lang=c>
@@ Line 167: / Line 169: @@
 </source>
-==== srTestSuiteAddCase ====
+== srTestSuiteAddCase ==
 The srTestSuiteAddCase() routine is used to add a new test case to the specified test suite.
 <source lang=c>
 srTestCaseHandle_t srTestSuiteAddCase(const srCHAR * szName, const srCHAR * szDescr)
 </source>
 {| border="1" cellspacing="0" cellpadding="10" style="align:left;"
@@ Line 194: / Line 198: @@
 | Handle of the newly created test case. srTEST_CASE_INVALID indicates failure to create a test case.
 |}
 <source lang=c>
@@ Line 215: / Line 220: @@
 </source>
-==== srTestSuiteAddAnnotation ====
+== srTestSuiteAddAnnotation ==
 The srTestSuiteAddAnnotation() routine is used to add a new annotation to the specified test suite.
 <source lang=c>
@@ Line 222: / Line 228: @@
                                                    const srCHAR * szFmtDescr, ...)
 </source>
 {| border="1" cellspacing="0" cellpadding="10" style="align:left;"
@@ Line 259: / Line 266: @@
 | Handle of the newly created test annotation. srTEST_ANNOTATION_INVALID indicates failure to create a test annotation.
 |}
 <source lang=c>
@@ Line 282: / Line 290: @@
-==== srTestSuiteSetData ====
+== srTestSuiteSetData ==
 The srTestSuiteSetData() routine is used to associate a custom name|value pair with a test suite.
 <source lang=c>
 srWORD srTestSuiteSetData(const srCHAR * szName, const srCHAR * szFmtValue, ...)
 </source>
 {| border="1" cellspacing="0" cellpadding="10" style="align:left;"
@@ Line 313: / Line 322: @@
 | srOK on success, srERR_HANDLE_INVALID on invalid handle.
 |}
 <source lang=c>
@@ Line 327: / Line 337: @@
 </source>
-==== srTestCaseSetStatus ====
+== srTestCaseSetStatus ==
 The srTestCaseSetStatus() routine is used to set the result of test case.
 <source lang=c>
 srWORD srTestCaseSetStatus(srTestCaseHandle_t tTestCase, srTestStatus_e eStatus, srDWORD dwDuration)
 </source>
 {| border="1" cellspacing="0" cellpadding="10" style="align:left;"
@@ Line 353: / Line 365: @@
 | dwDuration
 | Input
-| The duration of the test in clock ticks. Using "0" allows the STRIDE Runtime (Intercept Module) to set the time automatically.
+| The duration of the test in clock ticks. Using "0" allows the Stride Runtime (Intercept Module) to set the time automatically.
 |}
 <br>
@@ Line 363: / Line 375: @@
 | srOK on success, srERR_HANDLE_INVALID on invalid handle.
 |}
 <source lang=c>
@@ Line 377: / Line 390: @@
 </source>
-==== srTestCaseSetStatusEx ====
+== srTestCaseSetStatusEx ==
 The srTestCaseSetStatusEx() routine is used to set the result of test case and allow specification of an extendedFailureCode.
 <source lang=c>
 srWORD srTestCaseSetStatus(srTestCaseHandle_t tTestCase, srTestStatus_e eStatus, srDWORD dwDuration, srLONG lExtendedFailureCode)
 </source>
 {| border="1" cellspacing="0" cellpadding="10" style="align:left;"
@@ Line 398: / Line 413: @@
 | dwDuration
 | Input
-| The duration of the test in clock ticks. Using "0" allows the STRIDE Runtime (Intercept Module) to set the time automatically.
+| The duration of the test in clock ticks. Using "0" allows the Stride Runtime (Intercept Module) to set the time automatically.
 |-
 | lExtendedFailureCode
@@ Line 412: / Line 427: @@
 | srOK on success, srERR_HANDLE_INVALID on invalid handle.
 |}
 <source lang=c>
@@ Line 426: / Line 442: @@
 </source>
-==== srTestCaseAddAnnotation ====
+== srTestCaseAddAnnotation ==
 The srTestCaseAddAnnotation() routine is used to add a new annotation to the specified test case.
 <source lang=c>
 srTestAnnotationHandle_t srTestCaseAddAnnotation(rTestCaseHandle_t tTestCase, srTestAnnotationLevel_e eLevel, const srCHAR * szName, const srCHAR * szFmtDescr, ...)
 </source>
 {| border="1" cellspacing="0" cellpadding="10" style="align:left;"
@@ Line 472: / Line 490: @@
 | Handle of the newly created test annotation. srTEST_ANNOTATION_INVALID indicates failure to create a test annotation.
 |}
 <source lang=c>
@@ Line 495: / Line 514: @@
 </source>
-==== srTestCaseSetData ====
+== srTestCaseSetData ==
 The srTestCaseSetData() routine is used to associate a custom name|value pair with a test case.
 <source lang=c>
 srWORD srTestCaseSetData(srTestCaseHandle_t tTestCase, const srCHAR * szName, const srCHAR * szFmtValue, ...);
 </source>
 {| border="1" cellspacing="0" cellpadding="10" style="align:left;"
@@ Line 530: / Line 551: @@
 | srOK on success, srERR_HANDLE_INVALID on invalid handle.
 |}
 <source lang=c>
@@ Line 536: / Line 558: @@
 void tfcase_setData(void)
 {
-   srTestCaseSetData(srTEST_CASE_DEFAULT, "MyName", "my value);
+   srTestCaseSetData(srTEST_CASE_DEFAULT, "MyName", "my value");
 }
@@ Line 544: / Line 566: @@
 </source>
-==== srTestAnnotationAddComment ====
+== srTestAnnotationAddComment ==
 The srTestAnnotationAddComment() routine is used to add a comment (aka a log) to a test annotation.
 <source lang=c>
 srWORD srTestAnnotationAddComment(srTestAnnotationHandle_t tTestAnnotation, const srCHAR * szLabel, const srCHAR * szFmtComment, ...)
 </source>
 {| border="1" cellspacing="0" cellpadding="10" style="align:left;"
@@ Line 579: / Line 603: @@
 | srOK on success, srERR on null string or invalid formatted string, srERR_HANDLE_INVALID on invalid handle, srERR_STR_TRUNCATED on truncated string.
 |}
 <source lang=c>
@@ Line 599: / Line 624: @@
 </source>
-=== C++ Test Classes ===
+= C++ Test Classes =
 The Runtime Test Services C APIs work equally well from C test functions and C++ test classes. If, however, you are using C++ it might be more convinient for you to derive your C++ test classes from the Runtime Test Services C++ base class, ''srTest''. That way you will have access to a set of simpler to use C++ classes.
 The following C++ classes are provided:
 * '''[[#class srTest|class srTest]]''' - base test class
-* '''[[#class srTestSuite|class srTestSuite]]''' - represents a test suite
 * '''[[#class srTestCase|class srTestCase]]''' - represents a test case
 * '''[[#class srTestAnnotation|class srTestAnnotation]]''' - represents a test annotation
-==== class srTest ====
-The srTest class provides two Member Objects:
-*''testSuite'' of class srTestSuite
-*''testCase'' of class srTestCase
-==== class srTestSuite ====
+== class srTest ==
-The srTest class provides the folowing methods:
+The srTest class provides one member object ''testCase'' of [[#class srTestCase|class srTestCase]] and the folowing methods:
-===== method SetName =====
-The SetName method is used to set the name of test suite.
+=== method GetParam ===
+This overload of the GetParam() method is used to get the value of a named parameter as a string.
 <source lang=cpp>
-srWORD SetName(const srCHAR * szName)
+static srWORD GetParam(const srCHAR * name, srCHAR * value, srDWORD size, const srCHAR * defval = srNULL)
 </source>
 {| border="1" cellspacing="0" cellpadding="10" style="align:left;"
@@ Line 626: / Line 649: @@
 | '''Type'''
 | '''Description'''
 |-
-| szName
+| name
+| Input
+| Pointer to a null-terminated string that represents the name of the parameter. Cannot be null.
+|-
+| value
+| Output
+| Pointer to a block of memory to store the value of the parameter with a maximum size of <i>size</i> chars
+|-
+| size
 | Input
-| Pointer to null-terminated string representing the name of test suite. Cannot be empty.
+| Size in chars of the buffer pointed to by <i>value</i>
+|-
+| defvalue
+| Input (optional)
+| Pointer to a null-terminated string that represents a default value in case the parameter is not specified. By setting this value to srNULL (or omitting it), you can use <i>GetParam()</i> to test for the existence of a named parameter. If the named parameter doesn't exist, the function will return <i>srERR_HANDLE_INVALID</i>.
 |}
 <br>
@@ Line 636: / Line 671: @@
 | ''' Description'''
 |-
-| srOK
+| srWORD
-| Success
+| srOK on success, error otherwise.
-|-
-| srERR
-| Null string passed in.
-|-
-| srTEST_ERR_HANDLE_INVALID
-| Invalid handle passed in.
-|-
-| srTEST_WARN_STR_TRUNCATED
-| String passed in was too large and was truncated.
 |}
 <source lang=cpp>
@@ Line 655: / Line 682: @@
 {
 public:
-   void suiteSetName()
+   void getParam()
    {
-     testSuite.SetName("Setting name for suite");
+     GetParam("ParamName", szValue, MAX_VALUE_LEN, "default value");
    }
 };
@@ Line 666: / Line 693: @@
 </source>
-===== method SetDescription =====
-The SetDescription method is used to set the description of test suite.
+=== method GetParam ===
+This overload of the GetParam() method is used to get the value of a named parameter as a long.
 <source lang=cpp>
-srWORD SetDescription(const srCHAR * szDescr)
+static long GetParam(const srCHAR * name, srLONG defval = 0)
 </source>
 {| border="1" cellspacing="0" cellpadding="10" style="align:left;"
@@ Line 676: / Line 705: @@
 | '''Type'''
 | '''Description'''
 |-
-| szDescr
+| name
+| Input
+| Pointer to a null-terminated string that represents the name of the parameter.
+|-
+| defvalue
 | Input
-| Pointer to null-terminated string representing the description of test suite. Cannot be empty.
+| Default value that is returned if the parameter is not found.
 |}
 <br>
@@ Line 686: / Line 719: @@
 | ''' Description'''
 |-
-| srOK
+| srLONG
-| Success
+| Parameter value, or value specified by <i>defvalue</i> if parameter isn't found.
-|-
-| srERR
-| Null string passed in.
-|-
-| srTEST_ERR_HANDLE_INVALID
-| Invalid handle passed in.
-|-
-| srTEST_WARN_STR_TRUNCATED
-| String passed in was too large and was truncated.
 |}
 <source lang=cpp>
@@ Line 705: / Line 730: @@
 {
 public:
-   void suiteSetDescription()
+   void getParam()
    {
-     testSuite.SetDescription("Setting description for suite");
+     srLONG lValue = GetParam("ParamName", -1);
    }
 };
@@ Line 713: / Line 738: @@
 #ifdef _SCL
 #pragma scl_test_class(srtest_class)
-#endif
+#endif</source>
-</source>
-===== method AddSuite =====
+=== method GetParam ===
-The AddSuite<ref name=dynamic/> method is used to add a new test suite.
+This overload of the GetParam() method is used to get the value of a named parameter as a double.
 <source lang=cpp>
-srTestSuite AddSuite(const srCHAR * szName = srNULL)
+static double GetParam(const srCHAR * name, const double& defval)
 </source>
 {| border="1" cellspacing="0" cellpadding="10" style="align:left;"
@@ Line 726: / Line 752: @@
 | '''Type'''
 | '''Description'''
 |-
-|szName
+| name
-| Input (Optional)
+| Input
-| Pointer to null-terminated string that represents the name of test suite. If empty, the default host naming scheme will be used.
+| Pointer to a null-terminated string that represents the name of the parameter.
+|-
+| defvalue
+| Input
+| Default value that is returned if the parameter is not found.
 |}
 <br>
@@ Line 736: / Line 766: @@
 | ''' Description'''
 |-
-| srTestSuite
+| double
-| Newly created test suite class.
+| Parameter value, or value specified by <i>defvalue</i> if parameter isn't found.
 |}
 <source lang=cpp>
@@ Line 746: / Line 777: @@
 {
 public:
-   void suiteAddSuite()
+   void getParam()
    {
-     stride::srTestSuite suite = testSuite.AddSuite("tc Sub Suite");
+     double dbVal = GetParam("ParamName",  0.5772156649);
    }
 };
@@ Line 754: / Line 785: @@
 #ifdef _SCL
 #pragma scl_test_class(srtest_class)
-#endif
+#endif</source>
-</source>
-===== method AddCase =====
+=== method AddCase ===
-The AddCase<ref name=dynamic/> method is used to add a new test case to test suite.
+The AddCase method is used to add a new test case to the test suite.
 <source lang=cpp>
-srTestCase AddCase(const srCHAR * szName = srNULL)
+srTestCase AddCase(const srCHAR * name, const srCHAR * descr = srNULL)
 </source>
 {| border="1" cellspacing="0" cellpadding="10" style="align:left;"
@@ Line 768: / Line 800: @@
 | '''Description'''
 |-
-| szName
+| name
+| Input
+| Pointer to null-terminated string that represents the name of the new test case. If empty, the default host naming scheme will be used.
+|-
+| descr
 | Input (Optional)
-| Pointer to null-terminated string that represents the name of test case. If empty, the default host naming scheme will be used.
+| Pointer to null-terminated string representing the description of the new test case. If empty, description will be blank.
 |}
 <br>
@@ Line 778: / Line 814: @@
 |-
 | srTestCase
-| Newly created test case class.
+| Newly created test case instance.
 |}
 <br>
@@ Line 796: / Line 832: @@
        std::stringstream strm;
        strm << prefix << count;
-       stride::srTestCase tc = testSuite.AddCase(strm.str().c_str());
+       stride::srTestCase tc = AddCase(strm.str().c_str());
-      tc.AddComment("this is a dynamic test case");
        tc.SetStatus(srTEST_PASS);
      }
@@ Line 808: / Line 843: @@
 </source>
-===== method AddAnnotation =====
-The AddAnnotation method is used to add a new annotation to test suite.
+=== method AddAnnotation ===
+The AddAnnotation method is used to add a new test annotation to the test suite.
 <source lang=cpp>
-srTestAnnotation AddAnnotation(srTestAnnotationLevel_e eLevel, const srCHAR * szName = srNULL, const srCHAR * szDescr = srNULL)
+srTestAnnotation AddAnnotation(srTestAnnotationLevel_e level, const srCHAR * name, const srCHAR * descr, ...)
 </source>
 {| border="1" cellspacing="0" cellpadding="10" style="align:left;"
@@ Line 819: / Line 856: @@
 | '''Description'''
 |-
-| eLevel
+| level
 | Input
-| Annotation level. Cannot be empty.
+| Annotation level.
 * srTEST_ANNOTATION_LEVEL_TRACE,
@@ Line 830: / Line 867: @@
 * srTEST_ANNOTATION_LEVEL_FATAL
 |-
-| szName
+| name
-| Input (Optional)
+| Input
-| Pointer to null-terminated string that represents the name of annotation. If empty, the default host naming scheme will be used.
+| Pointer to null-terminated string that represents the name of the new annotation. If empty, the default host naming scheme will be used.
 |-
-| szDescr
+| descr
-| Input (Optional)
+| Input
-| Pointer to null-terminated string that represents the description of annotation. If empty, the description will be blank.
+| Pointer to null-terminated string representing the description of the new annotation. Cannot be null.
 |}
 <br>
@@ Line 844: / Line 881: @@
 |-
 | srTestAnnotation
-| Newly created annotation class.
+| Newly created annotation instance.
 |}
 <source lang=cpp>
@@ Line 862: / Line 900: @@
        strmName << "annotation " << count;
        strmDescr << "description of annotation " << count;
-       stride::srTestAnnotation ta =
+       stride::srTestAnnotation ta = AddAnnotation(srTEST_ANNOTATION_LEVEL_INFO,
-                 testSuite.AddAnnotation(srTEST_ANNOTATION_LEVEL_INFO,
+                                                  strmName.str().c_str(),
-                                         strmName.str().c_str(),
+                                                  strmDescr.str().c_str());
-                                         strmDescr.str().c_str());
      }
    }
@@ Line 875: / Line 912: @@
 </source>
-==== class srTestCase ====
-The srTestCase class provides the following methods:
-===== method SetName =====
+=== method SetData ===
-The SetName method is used to set the name of test case.
+The SetData method is used to associate a custom name|value pair with the test suite.
 <source lang=cpp>
-srWORD SetName(const srCHAR * szName)
+srWORD SetData(const srCHAR * name, const srCHAR * value, ...)
 </source>
 {| border="1" cellspacing="0" cellpadding="10" style="align:left;"
@@ Line 889: / Line 925: @@
 | '''Description'''
 |-
-| szName
+| name
 | Input
-| Pointer to null-terminated string representing the name of test case. Cannot be empty.
+| Pointer to a null-terminated string representing the name of the custom pair. Cannot be null.
+|-
+| value
+| Input
+| Pointer to a null-terminated string representing the value of the custom pair. Cannot be null.
 |}
 <br>
@@ Line 898: / Line 938: @@
 | ''' Description'''
 |-
-| srOK
+| srWORD
-| Success
+| srOK on success, srERR_HANDLE_INVALID on invalid handle.
-|-
-| srERR
-| Null string passed in.
-|-
-| srTEST_ERR_HANDLE_INVALID
-| Invalid handle passed in.
-|-
-| srTEST_WARN_STR_TRUNCATED
-| String passed in was too large and was truncated.
 |}
+<br>
+'''Example'''
 <source lang=cpp>
 #include <srtest.h>
+#include <sstream>
 class srtest_class : public stride::srTest
 {
 public:
-   void caseSetName()
+   void suiteSetData()
    {
-    testCase.SetName("Setting name for case");
+      SetData("MyName", "my value");
    }
 };
@@ Line 928: / Line 961: @@
 </source>
-===== method SetDescription =====
-The SetDescription method is used to set the description of test case.
-<source lang=cpp>
-srWORD SetDescription(const srCHAR * szDescr)
-</source>
-{| border="1" cellspacing="0" cellpadding="10" style="align:left;"
+== class srTestCase ==
-| '''Parameters'''
+The srTestCase class provides the following methods:
-| '''Type'''
-| '''Description'''
-|-
-| szDescr
-| Input
-| Pointer to null-terminated string representing the description of test case. Cannot be empty.
-|}
-<br>
-{| border="1" cellspacing="0" cellpadding="10" style="align:left;"
-| '''Return Value'''
-| ''' Description'''
-|-
-| srOK
-| Success
-|-
-| srERR
-| Null string passed in.
-|-
-| srTEST_ERR_HANDLE_INVALID
-| Invalid handle passed in.
-|-
-| srTEST_WARN_STR_TRUNCATED
-| String passed in was too large and was truncated.
-|}
+=== method SetStatus ===
+The SetStatus method is used to set the result of the default test case.
 <source lang=cpp>
-#include <srtest.h>
+srWORD SetStatus(srTestStatus_e status, srDWORD duration = 0)
-class srtest_class : public stride::srTest
-{
-public:
-  void caseSetDescription()
-  {
-    testCase.SetDescription("Setting description for case");
-  }
-};
-#ifdef _SCL
-#pragma scl_test_class(srtest_class)
-#endif
 </source>
-===== method SetStatus =====
-The SetStatus method is used to set the result of the default test case.
-<source lang=cpp>
-srWORD SetStatus(srTestStatus_e eStatus, srDWORD dwDuration = 0)
-</source>
 {| border="1" cellspacing="0" cellpadding="10" style="align:left;"
@@ Line 989: / Line 977: @@
 | '''Description'''
 |-
-| eStatus
+| status
 | Input
 | Result of the test. Possible values are:
@@ Line 998: / Line 986: @@
 * '''srTEST_DONE''' - applicable to dynamic cases - sets the status to '''pass''' unless already set to '''fail''' or '''not-in-use'''
 |-
-| dwDuration
+| duration
 | Input (Optional)
 | The duration of the test in clock ticks. The default is 0.
@@ Line 1,007: / Line 995: @@
 | ''' Description'''
 |-
-| srOK
+| srWORD
-| Success
+| srOK on success, srERR_HANDLE_INVALID on invalid handle.
-|-
-| srTEST_ERR_HANDLE_INVALID
-| Invalid handle.
 |}
 <source lang=cpp>
@@ Line 1,022: / Line 1,008: @@
    void caseSetStatus()
    {
-     testCase.SetStatus(srTEST_NOTINUSE, 0);
+     testCase.SetStatus(srTEST_NOTINUSE);
    }
 };
@@ Line 1,031: / Line 1,017: @@
 </source>
-===== method AddComment =====
-The AddComment method is used to add a comment to test case.
+=== method AddAnnotation ===
+The AddAnnotation method is used to add a new test annotation to the test case.
 <source lang=cpp>
-srWORD AddComment(const srCHAR * szLabel, const srCHAR * szFmtComment, ...)
+srTestAnnotation AddAnnotation(srTestAnnotationLevel_e level, const srCHAR * name, const srCHAR * descr, ...)
 </source>
 {| border="1" cellspacing="0" cellpadding="10" style="align:left;"
@@ Line 1,041: / Line 1,029: @@
 | '''Type'''
 | '''Description'''
 |-
+| level
+| Input
+| Annotation level.
-| szLabel
+* srTEST_ANNOTATION_LEVEL_TRACE,
+* srTEST_ANNOTATION_LEVEL_DEBUG,
+* srTEST_ANNOTATION_LEVEL_INFO,
+* srTEST_ANNOTATION_LEVEL_WARN,
+* srTEST_ANNOTATION_LEVEL_ERROR,
+* srTEST_ANNOTATION_LEVEL_FATAL
+|-
+| name
+| Input
+| Pointer to null-terminated string that represents the name of the new annotation. If null, the default host naming scheme will be used.
+|-
+| descr
 | Input
-| Pointer to a null-terminated string representing the comment label.
+| Pointer to null-terminated string representing the description of the new annotation. Cannot be null.
-|-
-| szFmtComment
-| Input
-| Pointer to null-terminated string, which can be formatted, representing the comment. Cannot be empty.
-|-
-| ...
-| Input (Optional)
-| Variable argument list to format the comment szFmtComment.
 |}
 <br>
@@ Line 1,060: / Line 1,054: @@
 | ''' Description'''
 |-
-| srOK
+| srTestAnnotation
-| Success
+| Newly created annotation instance.
-|-
-| srERR
-| Null string passed in.
-|-
-| srTEST_WARN_STR_TRUNCATED
-| String passed in was too large and was truncated.
 |}
 <source lang=cpp>
 #include <srtest.h>
+#include <sstream>
 class srtest_class : public stride::srTest
 {
 public:
-   void caseAddComment()
+   void caseAddAnnotation()
    {
-     testCase.AddComment("this comment should print %s", "A STRING");
+     for (int count = 0; count < 5; ++count)
+    {
+      std::stringstream strmName;
+      std::stringstream strmDescr;
+      strmName << "annotation " << count;
+      strmDescr << "description of annotation " << count;
+      stride::srTestAnnotation ta =
+                 testCase.AddAnnotation(srTEST_ANNOTATION_LEVEL_INFO,
+                                         strmName.str().c_str(),
+                                         strmDescr.str().c_str());
+    }
    }
 };
@@ Line 1,087: / Line 1,087: @@
 </source>
-===== method AddAnnotation =====
-The AddAnnotation method is used to add a new annotation to test case.
+=== method SetData ===
+The SetData method is used to associate a custom name|value pair with the test case.
 <source lang=cpp>
-srTestAnnotation AddAnnotation(srTestAnnotationLevel_e eLevel, const srCHAR * szName = srNULL, const srCHAR * szDescr = srNULL)
+srWORD SetData(const srCHAR * name, const srCHAR * value, ...)
 </source>
 {| border="1" cellspacing="0" cellpadding="10" style="align:left;"
@@ Line 1,098: / Line 1,100: @@
 | '''Description'''
 |-
-| eLevel
+| name
 | Input
-| Annotation level. Cannot be empty.
+| Pointer to a null-terminated string representing the name of the custom pair. Cannot be null.
-* srTEST_ANNOTATION_LEVEL_TRACE,
-* srTEST_ANNOTATION_LEVEL_DEBUG,
-* srTEST_ANNOTATION_LEVEL_INFO,
-* srTEST_ANNOTATION_LEVEL_WARN,
-* srTEST_ANNOTATION_LEVEL_ERROR,
-* srTEST_ANNOTATION_LEVEL_FATAL
 |-
-| szName
+| value
-| Input (Optional)
+| Input
-| Pointer to null-terminated string that represents the name of annotation. If empty, the default host naming scheme will be used.
+| Pointer to a null-terminated string representing the value of the custom pair. Cannot be null.
-|-
-| szDescr
-| Input (Optional)
-| Pointer to null-terminated string that represents the description of annotation. If empty, the description will be blank.
 |}
 <br>
@@ Line 1,122: / Line 1,113: @@
 | ''' Description'''
 |-
-| srTestAnnotation
+| srWORD
-| Newly created annotation class.
+| srOK on success, srERR_HANDLE_INVALID on invalid handle.
 |}
 <source lang=cpp>
 #include <srtest.h>
-#include <sstream>
 class srtest_class : public stride::srTest
 {
 public:
-   void caseAddAnnotation()
+   void caseSetData()
    {
-     for (int count = 0; count < 5; ++count)
+     testCase.SetData("MyName", "my value");
-    {
-      std::stringstream strmName;
-      std::stringstream strmDescr;
-      strmName << "annotation " << count;
-      strmDescr << "description of annotation " << count;
-      stride::srTestAnnotation ta =
-                 testCase.AddAnnotation(srTEST_ANNOTATION_LEVEL_INFO,
-                                         strmName.str().c_str(),
-                                         strmDescr.str().c_str());
-    }
    }
 };
@@ Line 1,154: / Line 1,135: @@
 </source>
-==== class srTestAnnotation ====
+== class srTestAnnotation ==
 The srTestAnnotation class provides the following methods:
-===== method AddComment =====
+=== method AddComment ===
 The AddComment method is used to add a comment to the test annotation.
 <source lang=cpp>
 srWORD AddComment(const srCHAR * label, const srCHAR * comment, ...)
 </source>
 {| border="1" cellspacing="0" cellpadding="10" style="align:left;"
@@ Line 1,175: / Line 1,159: @@
 | Input
 | Pointer to null-terminated string representing the new comment. Cannot be empty.
-|-
-| ...
-| Input (Optional)
-| Variable argument list to format comment.
 |}
 <br>
@@ Line 1,188: / Line 1,168: @@
 | srOK on success, srERR on null string or invalid formatted string, srERR_HANDLE_INVALID on invalid handle, srERR_STR_TRUNCATED on truncated string.
 |}
 <source lang=cpp>
@@ Line 1,209: / Line 1,190: @@
 #endif
 </source>
-[[Category:Test Units]]