Share this page

# web_report_data_point

Miscellaneous Functions

Specifies a data point and adds it to the test results.

int web_report_data_point( const char *EventType, const char *EventName , const char *DataPointName , LAST );

Argument | Description
--- | ---
List of Attributes | The following attributes are available: EventType: Specifies the type of event to report. Currently, the only supported event is "Error". Use the format `"EventType=`string`"`. EventName: Specifies the name of the event to report. Currently, the only supported event is "StepTimeOut". Use the format `"EventName=`string`"`. DataPointName: A user-defined string specifying the data point name. Use the format `"DataPointName=`string`"`.
LAST | A marker that indicates the end of the attribute list.

## Return Values

This function returns LR_PASS (0) on success, and LR_FAIL (1) on failure.

## Parameterization

All arguments can be parameterized using standard parameterization.

## General Information

The web_report_data_point function defines a data point within the script to be included in the test results. The most common datapoint is a step timeout, indicating if the previous step timed out.

Data points created with web_report_data_point appear in the Online graphs in the Controller.

## Example

In the following example, web_report_data_point creates a data point in the case of a step download timeout.

In Runtime Settings > Miscellaneous, select "Continue on error" to run the example.

    web_save_header(RESPONSE,"response header");
    // Set up to fail the web_url by setting an unreasonable timeout.
    web_set_timeout("Step", "1");
    web_url("cookie.html",
         "URL=http://www.kellynch_hall.com/walter_elliot/no_cookie.html",
         "TargetFrame=_TOP",
         LAST );
    web_report_data_point( "EventType=Error" ,
    "EventName=StepTimeOut" , "DataPointName=timeout" , LAST );

Tips to improve your search results... VuGen Function Reference Version 26.1 Function Reference 26.1 All View Local Help Center View Online Help Center Version: