CanEasy COM-Help
CanEasy::ITestReport Interface Reference

Inherits IDispatch.

Detailed Description

Allows creating test reports as html and xml

interface ITestReport : IDispatch
{
HRESULT AddEngineerInfo([in] BSTR name, [in] BSTR description);
HRESULT AddSetupInfo([in] BSTR name, [in] BSTR description);
HRESULT AddSUTInfo([in] BSTR name, [in] BSTR description);
HRESULT AddMiscInfo([in] BSTR name, [in] BSTR description);
HRESULT Title([out, retval] BSTR* name);
HRESULT Title([in] BSTR name);
HRESULT Description([out, retval] BSTR* desc);
HRESULT Description([in] BSTR desc);
HRESULT Filename([out, retval] BSTR* file);
HRESULT Filename([in] BSTR file);
HRESULT Comment([in] BSTR comment);
HRESULT Step([in] BSTR identifier, [in] BSTR desc, [in, optional] VARIANT level);
HRESULT StepPass([in] BSTR identifier, [in] BSTR desc, [in, optional] VARIANT level);
HRESULT StepFail([in] BSTR identifier, [in] BSTR desc, [in, optional] VARIANT level);
HRESULT StepWarning([in] BSTR identifier, [in] BSTR desc, [in, optional] VARIANT level);
HRESULT StepInconclusive([in] BSTR identifier, [in] BSTR desc, [in, optional] VARIANT level);
HRESULT StepErrorInTestSystem([in] BSTR identifier, [in] BSTR desc, [in, optional] VARIANT level);
HRESULT OpenTestcase([in] BSTR name, [in] BSTR desc, [in] BSTR identifier);
HRESULT OpenPattern([in] BSTR name, [in] BSTR desc, [in] BSTR identifier);
HRESULT OpenGroup([in] BSTR name, [in] BSTR desc, [in] BSTR identifier);
HRESULT SetGroupTitle([in] BSTR identifier, [in] BSTR name);
HRESULT GroupLevel([out, retval] long* level);
HRESULT CloseTestcase();
HRESULT ClosePattern();
HRESULT CloseGroup();
HRESULT StartTestReport([in] BSTR outDir, [in] BSTR name);
HRESULT CloseTestReport();
};

Definition at line 10288 of file cand_tlb.idl.

Member Function Documentation

◆ AddEngineerInfo()

HRESULT CanEasy::ITestReport::AddEngineerInfo ( [in] BSTR  name,
[in] BSTR  description 
)

Adds information about the engineer

◆ AddMiscInfo()

HRESULT CanEasy::ITestReport::AddMiscInfo ( [in] BSTR  name,
[in] BSTR  description 
)

Adds information about the misc

◆ AddSetupInfo()

HRESULT CanEasy::ITestReport::AddSetupInfo ( [in] BSTR  name,
[in] BSTR  description 
)

Adds information about the setup

◆ AddSUTInfo()

HRESULT CanEasy::ITestReport::AddSUTInfo ( [in] BSTR  name,
[in] BSTR  description 
)

Adds information about the system under test

◆ CloseGroup()

HRESULT CanEasy::ITestReport::CloseGroup ( )

Closes the opened group

◆ ClosePattern()

HRESULT CanEasy::ITestReport::ClosePattern ( )

Closes the opened pattern

◆ CloseTestcase()

HRESULT CanEasy::ITestReport::CloseTestcase ( )

Closes the opened test case

◆ CloseTestReport()

HRESULT CanEasy::ITestReport::CloseTestReport ( )

Closes the test report.

HTML file is created.

◆ Comment()

HRESULT CanEasy::ITestReport::Comment ( [in] BSTR  comment)

Comments added into the test report

◆ OpenGroup()

HRESULT CanEasy::ITestReport::OpenGroup ( [in] BSTR  name,
[in] BSTR  desc,
[in] BSTR  identifier 
)

Opens a new group

◆ OpenPattern()

HRESULT CanEasy::ITestReport::OpenPattern ( [in] BSTR  name,
[in] BSTR  desc,
[in] BSTR  identifier 
)

Opens a new pattern

◆ OpenTestcase()

HRESULT CanEasy::ITestReport::OpenTestcase ( [in] BSTR  name,
[in] BSTR  desc,
[in] BSTR  identifier 
)

Opens a new test case

◆ SetGroupTitle()

HRESULT CanEasy::ITestReport::SetGroupTitle ( [in] BSTR  identifier,
[in] BSTR  name 
)

Sets the group title name

◆ StartTestReport()

HRESULT CanEasy::ITestReport::StartTestReport ( [in] BSTR  outDir,
[in] BSTR  name 
)

Start a test report

Parameters
outDirFolder to output the test report
nameFile name of the test report

◆ Step()

HRESULT CanEasy::ITestReport::Step ( [in] BSTR  identifier,
[in] BSTR  desc,
[in, optional] VARIANT  level 
)

Step added into the test report

◆ StepErrorInTestSystem()

HRESULT CanEasy::ITestReport::StepErrorInTestSystem ( [in] BSTR  identifier,
[in] BSTR  desc,
[in, optional] VARIANT  level 
)

TestSystem errror step added into the test report

◆ StepFail()

HRESULT CanEasy::ITestReport::StepFail ( [in] BSTR  identifier,
[in] BSTR  desc,
[in, optional] VARIANT  level 
)

Failed step added into the test report

◆ StepInconclusive()

HRESULT CanEasy::ITestReport::StepInconclusive ( [in] BSTR  identifier,
[in] BSTR  desc,
[in, optional] VARIANT  level 
)

Inconclusive step added into the test report

◆ StepPass()

HRESULT CanEasy::ITestReport::StepPass ( [in] BSTR  identifier,
[in] BSTR  desc,
[in, optional] VARIANT  level 
)

Passed step added into the test report

◆ StepWarning()

HRESULT CanEasy::ITestReport::StepWarning ( [in] BSTR  identifier,
[in] BSTR  desc,
[in, optional] VARIANT  level 
)

Warning step added into the test report

Property Documentation

◆ Description

BSTR CanEasy::ITestReport::Description
getset

Description of the test report

◆ Filename

BSTR CanEasy::ITestReport::Filename
getset

Filename where to write the test report

◆ GroupLevel

long CanEasy::ITestReport::GroupLevel
get

Returns to group level

◆ Title

BSTR CanEasy::ITestReport::Title
getset

Title of the test report

CanEasy::ITestReport::Filename
BSTR Filename
CanEasy::ITestReport::AddEngineerInfo
HRESULT AddEngineerInfo([in] BSTR name, [in] BSTR description)
CanEasy::ITestReport::StartTestReport
HRESULT StartTestReport([in] BSTR outDir, [in] BSTR name)
CanEasy::ITestReport::StepFail
HRESULT StepFail([in] BSTR identifier, [in] BSTR desc, [in, optional] VARIANT level)
CanEasy::ITestReport::StepInconclusive
HRESULT StepInconclusive([in] BSTR identifier, [in] BSTR desc, [in, optional] VARIANT level)
CanEasy::ITestReport::CloseTestcase
HRESULT CloseTestcase()
CanEasy::ITestReport::AddSUTInfo
HRESULT AddSUTInfo([in] BSTR name, [in] BSTR description)
CanEasy::ITestReport::StepWarning
HRESULT StepWarning([in] BSTR identifier, [in] BSTR desc, [in, optional] VARIANT level)
CanEasy::ITestReport::StepPass
HRESULT StepPass([in] BSTR identifier, [in] BSTR desc, [in, optional] VARIANT level)
CanEasy::ITestReport::AddSetupInfo
HRESULT AddSetupInfo([in] BSTR name, [in] BSTR description)
CanEasy::ITestReport::OpenPattern
HRESULT OpenPattern([in] BSTR name, [in] BSTR desc, [in] BSTR identifier)
CanEasy::ITestReport::OpenGroup
HRESULT OpenGroup([in] BSTR name, [in] BSTR desc, [in] BSTR identifier)
CanEasy::ITestReport::ClosePattern
HRESULT ClosePattern()
CanEasy::ITestReport::AddMiscInfo
HRESULT AddMiscInfo([in] BSTR name, [in] BSTR description)
CanEasy::ITestReport::OpenTestcase
HRESULT OpenTestcase([in] BSTR name, [in] BSTR desc, [in] BSTR identifier)
CanEasy::ITestReport::SetGroupTitle
HRESULT SetGroupTitle([in] BSTR identifier, [in] BSTR name)
CanEasy::ITestReport::Description
BSTR Description
CanEasy::ITestReport::Comment
HRESULT Comment([in] BSTR comment)
CanEasy::ITestReport::CloseTestReport
HRESULT CloseTestReport()
Closes the test report.
CanEasy::ITestReport::GroupLevel
long GroupLevel
CanEasy::ITestReport::StepErrorInTestSystem
HRESULT StepErrorInTestSystem([in] BSTR identifier, [in] BSTR desc, [in, optional] VARIANT level)
CanEasy::ITestReport::Step
HRESULT Step([in] BSTR identifier, [in] BSTR desc, [in, optional] VARIANT level)
CanEasy::ITestReport::CloseGroup
HRESULT CloseGroup()
CanEasy::ITestReport::Title
BSTR Title