GetReportSectionNumber

Description

GetReportSectionNumber returns the number of section in the report a test needs.

Syntax

int GetReportSectionNumber(const unsigned int iunTestIndex, unsigned int& ounReportSectionNb);

Parameters

Input

iunTestIndex: the identification number of the test for which HOA asks the number of section needed.

Output

ounReportSectionNb: the number of section in the report the test "iunTestIndex" needs.

Return

(int): returns the identification number of the error if an error occurs or 0 if no error occurs.

Example

To get a full example of the API use, download the .Plugin

#define OPT_PLUGIN_NO_ERROR 0
int GetReportSectionNumber(const unsigned int iunTestIndex, unsigned int& ounReportSectionNb)
{	
     switch (iunTestIndex)
     {
case 0:
    ounReportSectionNb = 1;
break;
case 1:
    ounReportSectionNb = 3;
break;
case 2:
    ounReportSectionNb = 1;
break;
     }
     return OPT_PLUGIN_NO_ERROR;
}