Share this page

# ajax_rating

Note: This protocol is supported for replay only. Support for this protocol will be discontinued in future versions..

We recommend that you migrate your Ajax Click & Script scripts to another web protocol such as TruClient-Web or Web-HTTP/HTML.

For details, see Web Vuser Functions (WEB) and TruClient protocols in the VuGen Help Center (select the relevant version).

Emulates a user setting the value of a rating control.

AJAX Click and Script Functions

    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.

Function Arguments table

Argument | Description
--- | ---
StepName | The name of the step, as it appears in the test tree. Any text can be used.
Framework | The software used to create the AJAX application. For this function, the "`Atlas"` framework is supported.
ID | The control ID.
UserAction | Set the rating.
Value | The rating assigned to the specified control.

General Arguments table

Argument | Description
--- | ---
DESCRIPTION | This delimiter marks the beginning of the list of attributes that identify the element on which the function operates.
ACTION | This delimiter marks the beginning of the action list. When there are no action-type arguments, this argument can be omitted, but it is not an error to specify it.
LAST | This delimiter marks the end of the argument list.

## 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).

## Example

This example shows a user giving a rating.

    web_text_link
    ("Rating",
      "Snapshot=t1.inf",
      DESCRIPTION,
      "Text=Rating",
      ACTION,
      "UserAction=Click",
      LAST );

    ajax_rating
    ("Rating_2",
      "Snapshot=t1.inf",
      DESCRIPTION,
      "Framework=atlas",
      "ID=ctl00_SampleContent_ThaiRating",
      ACTION,
      "UserAction=SetRate",
      "Value=3",
      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: