AJAX Click and Script Functions > Alphabetical List of Functions > ajax_rating

Support for the Click & Script protocols will be discontinued in an upcoming version.

ajax_rating

Emulates a user setting the value of a rating control.

Example: ajax_rating Alphabetical Listing
int ajax_rating( "stepname", DESCRIPTION, "Framework=framework name", "ID=control_id", ACTION, "UserAction=SetRate", "Value=rating_value", LAST );

This function returns LR_PASS (0) on success or LR_FAIL (1) on failure. Note that LR_PASS and LR_FAIL generally indicate whether the function call completed without an exception, and not that the test step succeeded.

All input string arguments (char type) except the step name can be parameterized using standard parameterization.

General Information

The ajax_rating function emulates a user setting a rating on a control by selecting the number of stars. The function receives as input the ID of the control to which the rating applies, and the user's rating (usually a number between 1 to 5).