Analog functions

check_window Compares a bitmap of an AUT window to an expected bitmap.

click Clicks a mouse button.
click_on_text Clicks a mouse button on a string.
dbl_click Double-clicks a mouse button.
get_x Returns the current x-coordinate of the mouse pointer.
get_y Returns the current y-coordinate of the mouse pointer.
move_locator_abs Moves the mouse to a new absolute position.
move_locator_rel Moves the mouse to a new relative position.
move_locator_text Moves the mouse to a string.
move_locator_track Moves the mouse along a prerecorded track.
mtype Clicks one or more mouse buttons
type Specifies keyboard input.
wait_window Waits for a window bitmap to appear in order to synchronize test execution.
click_on_text Clicks on a string.
find_text Searches for a string.
get_text Reads text from the screen.
move_locator_text Moves the mouse to a string.
tbl_click_cell Clicks in a cell in a JFC JTable object.
tbl_dbl_click_cell Double-clicks in a cell in a JFC JTable object.
tbl_drag Drags a cell to a different location within a JFC JTable object.
Context sensitive functions
ActiveBar_combo_select_item Selects an item in a ComboBox tool.
ActiveBar_dump Stores information about ActiveBar bands and tools. This information
includes captions, names, types and IDs.
ActiveBar_select_menu Selects a menu item in a toolbar.
ActiveBar_select_tool Selects a tool in the toolbar.
ActiveX_activate_method Invokes an ActiveX method of an ActiveX control.
ActiveX_get_info Returns the value of an ActiveX/Visual Basic control property.
ActiveX_set_info Sets the value of a property in an ActiveX/Visual Basic control.
vb_get_label_names Retrieves the names of all label controls in the given form window. The
names are stored as subscripts of an array.
win_check_bitmap Compares a current window bitmap to an expected bitmap.
obj_check_bitmap Compares a current object bitmap to an expected bitmap.
button_check_info Checks the value of a button property.
button_check_state Checks the state of a radio or check button.
button_get_info Returns the value of a button property.
button_get_state Returns the state of a radio or check button.
button_press Clicks a push button.
button_set Sets the state of a radio or check button.
button_wait_info Waits for the value of a button property.
The calendar_ functions are available for calendars included in Visual Studio version 6 and
higher and in Internet Explorer Active Desktop version 4 and higher.
calendar_activate_date Double clicks the specified date in the calendar.
calendar_get_selected Retrieves and counts the selected dates in a calendar.
calendar_get_status Returns the status validity of the date.
calendar_get_valid_range Returns the date range.
calendar_select_date Clicks the specified date in a calendar.
calendar_select_range Clicks the specified date in a calendar.
calendar_select_time Selects a time in the HH:MM:SS format.
calendar_set_status Sets the selection status to valid or invalid.
db_check Compares current database data to expected database data.
db_connect Creates a new database session and establishes a connection to an ODBC
database.
db_disconnect Disconnects from the database and ends the database session.
db_execute_query Executes the query based on the SQL statement and creates a record set.
db_get_field_value Returns the value of a single field in the database.
db_get_headers Returns the number of column headers in a query and the content of the
column headers, concatenated and delimited by tabs.
db_get_last_error Returns the last error message of the last ODBC or Data Junction
operation.
db_get_row Returns the content of the row, concatenated and delimited by tabs.
db_record_check Compares information that appears in the application under test during a
test run with the current values in the corresponding record(s) in
your database.
db_write_records Writes the record set into a text file delimited by tabs.
Database Function for Working with Data Junction
db_dj_convert runs a Data Junction export file (.djs file).
ddt_close Closes a data table file.
ddt_close_all_tables Closes all open tables in all open tests.
ddt_export Exports the information of one table file into a different table file.
ddt_get_current_row Retrieves the active row in a data table.
ddt_get_parameters Returns a list of all parameters in a data table.
ddt_get_row_count Retrieves the number of rows in a data table.
ddt_is_parameter Returns whether a parameter in a data table is valid.
ddt_next_row Changes the active row in a data table to the next row.
ddt_open_ Creates or opens a data table file so that WinRunner can access it.
ddt_report_row Reports the active row in a data table to the test results.
ddt_save Saves the information in a data table.
ddt_set_row Sets the active row in a data table.
ddt_set_val Sets a value in the current row of the data table.
ddt_set_val_by_row Sets a value in the specified row of the data table.
ddt_show Shows or hides the table editor of a specified data table.
ddt_update_from_db Imports data from a database into a data table.
ddt_val Returns the value of a parameter in the active row in a data table.
ddt_val_by_row_ Returns the value of a parameter in the specified row in a data table.
date_age_string Ages date string and returns the aged date.
date_align_day Ages dates to a business day or to the same day of the week.
date_calc_days_in_field Calculates the number of days between two dates.
date_calc_days_in_string Calculates the number of days between two numeric strings.
date_change_field_aging Overrides aging on a specified date object.
date_change_original_new_formats Overrides automatic date recognition for a specified object.
date_disable_format Disables a date format.
date_enable_format Enables a date format.
date_field_to_Julian Translates a date field to a Julian number.
date_is_field Determines whether a field contains a valid date.
date_is_string Determines whether a numeric string contains a valid date.
date_is_leap_year Determines whether a year is a leap year.
date_leading_zero Determines whether to add a zero before single-digit numbers when aging
and translating dates.
date_month_language Sets the language used for month names.
date_set_aging Sets aging in a test script.
date_set_run_mode Changes the date operations run mode in the test script.
date_set_system_date Changes the system date and time.
date_set_year_limits Sets the minimum and maximum years valid for date verification and
aging.
date_set_year_threshold Sets the year threshold.
date_string_to_Julian Translates a numeric string to a Julian number.
date_type_mode Disables overriding of automatic date recognition for all date objects in a
GUI application.
add_dlph_obj Adds a Delphi object.
dlph_edit_set Replaces the entire content of a Delphi edit object.
dlph_list_select_item Selects a Delphi list item.
dlph_obj_get_info Retrieves the value of a Delphi object.
dlph_obj_set_info Sets the value of a Delphi object.
dlph_panel_button_press Clicks a button within a Delphi panel.
edit_check_info Checks the value of an edit object property.
edit_check_selection Checks that a string is selected.
edit_check_text Checks the contents of an edit object.
edit_delete Deletes the contents of an edit object.
edit_delete_block Deletes a text block from an edit object.
edit_get_blockReturns a block of text from an edit object.
edit_get_info Returns the value of an edit object property.
edit_get_row_length Returns the length of a row in an edit object.
edit_get_rows_count Returns the number of rows written in an edit object.
edit_get_selection Returns the selected string in an edit object.
edit_get_selection_pos Returns the position at which the selected block starts and ends.
edit_get_text Returns the text in an edit object.
edit_insert Inserts text in an edit object.
edit_insert_block Inserts text in a multi-line edit object.
edit_replace Replaces part of the contents of an edit object.
edit_replace_block Replaces a block of text in a multi-line edit object.
edit_set Replaces the entire contents of an edit object.
edit_set_insert_pos Places the cursor at the specified point in an edit object.
edit_set_selection Selects text in an edit object.
edit_type Types a string in an edit object.
edit_wait_info Waits for the value of an edit object property.
EURO_check_currency Captures and compares the currencies in a window.
EURO_compare_columns Compares two currency columns (dual display) and returns the
number of mismatches.
EURO_compare_fields Compares two fields while converting.
EURO_compare_numbers Compares two numbers while converting.
EURO_convert_currency Returns the converted currency value between two currencies.
EURO_override_field Overrides the original currency in a field to a new currency.
EURO_set_auto_currency_verify Activates/deactivates automatic EURO verification.
EURO_set_capture_mode Determines how WinRunner EURO captures currency in terminal
emulator applications.
EURO_set_conversion_modeSets the EURO conversion run mode in the test script.
EURO_set_conversion_rate Sets the conversion rate between the EURO currency and a
national currency.
EURO_set_cross_rate Sets the cross rate method between two currencies.
EURO_set_currency_threshold Sets the minimum value of an integer which will be
considered a currency.
EURO_set_decimals_precision Sets the number of decimals in the conversion results.
EURO_set_original_new_currencies Sets the original and new currencies of the application.
EURO_set_regional_symbolsSets the character used as decimal separator and the character used
to separate groups of digits to the left of the decimal.
EURO_set_triangulation_decimals Sets the default decimals precision for the EURO
triangulation.
EURO_type_mode Disables/enables overriding of automatic currency recognition for all
integer objects in a GUI application.
obj_check_gui Compares current GUI data to expected GUI data for any class of object.
win_check_gui Compares current GUI data to expected GUI data for a window.
get_class_map Returns the standard class associated with a custom class.
get_record_attr Returns the properties recorded for an object class.
get_record_method Returns the recording method used for an object class.
set_class_map Associates a custom class with a standard class.
set_record_attrSets the properties to learn for an object class.
set_record_method Specifies the record method for a class.
unset_class_map Unbinds a custom class from a standard class.
GUI_add Adds an object to a GUI map file.
GUI_buf_get_desc Returns the physical description of an object in a GUI map file.
GUI_buf_get_desc_attr Returns the value of an object property in a GUI map file.
GUI_buf_get_logical_name Returns the logical name of an object in a GUI map file.
GUI_buf_new Creates a new GUI map file.
GUI_buf_set_desc_attr Sets the value of a property in a GUI map file.
GUI_close Closes a GUI map file.
GUI_close_all Closes all GUI map files.
GUI_delete Deletes an object from a GUI map file.
GUI_desc_compare Compares two physical descriptions.
GUI_desc_get_attr Gets the value of a property from a physical description.
GUI_desc_set_attr Sets the value of a property.
GUI_get_name Returns the type of GUI for the application under test.
GUI_get_window Returns the active window in the GUI map.
GUI_list_buf_windows Lists all windows in a GUI map file.
GUI_list_buffers Lists all open GUI map files.
GUI_list_desc_attrs Returns a list of all property values for an object.
GUI_list_map_buffers Lists all loaded GUI map files.
GUI_list_win_objects Lists all objects in a window.
GUI_load Loads a GUI map file.
GUI_map_get_desc Returns the description of an object in the GUI map.
GUI_map_get_logical_name Returns the logical name of an object in the GUI map.
GUI_open Opens a GUI map file.
GUI_save Saves a GUI map file.
GUI_save_as Saves a GUI map file under a new name.
GUI_set_window Sets the scope for identifying objects in the GUI map.
GUI_unload Unloads a GUI map file.
GUI_unload_all Unloads all loaded GUI map files.
icon_move Moves an icon to a new location.
icon_select Clicks an icon.
java_activate_method Invokes the requested Java method for the given object.
java_fire_event Simulates an event on a Java object.
jco_create Creates a Java object within the context of an existing Java object.
jco_free Frees the specified jco object from memory.
jco_free_all Frees all jco objects from memory.
jdc_aut_connect Establishes a connection between WinRunner and Java applications.
method_wizard Launches the Java Method wizard, which enables you to view the methods
associated with any jco object in your application or applet and to generate
the appropriate java_activate_method statement for one of the displayed
methods.
obj_key_type Sends KeyEvents to a Java component.
obj_set_info Sets the value of an object property.
popup_select_item Selects an item from a Java popup menu.
list_activate_item Activates an item.
list_check_info Checks the value of a list property.
list_check_item Checks the content of an item in a list.
list_check_selected Checks that the specified item is selected.
list_collapse_item Hides items in a tree view object.
list_deselect_item Deselects an item.
list_deselect_range Deselects all items between two specified items.
list_drag_item Drags an item from a source list.
list_drop_on item Drops an object onto a target list item.
list_expand_item Displays hidden items in a tree view object.
list_extend_item Adds an item to the items already selected.
list_extend_multi_items Adds multiple items to the items already selected.
list_extend_range Selects a range of items and adds them to the items currently selected.
list_get_checked_items Returns the value of items marked as checked.
list_get_column_header Returns the value of a ListView column header.
list_get_info Returns the value of a list property.
list_get_item Returns the contents of an item.
list_get_item_coord Returns the dimensions and coordinates of the list item.
list_get_item_info Returns the state of a list item.
list_get_item_num Returns the position of an item.
list_get_selected Returns the currently selected item.
list_get_subitem Returns the value of the ListView subitem.
list_rename_item Activates an item's edit mode in order to rename it.
list_select_item Selects an item in a list.
list_select_multi_items Selects items in a multiple-selection container object.
list_select_range Selects all items between two specified items.
list_set_item_state Sets the state of an icon of the specified ListView or TreeView.
list_wait_info Waits for the value of a list property.
menu_get_desc Returns the physical description of a menu.
menu_get_info Returns the value of a menu property.
menu_get_item Returns the contents of an item.
menu_get_item_num Returns the position of an item.
menu_select_item Selects an item.
menu_wait_info Waits for the value of a menu property.
obj_check_bitmap Compares a current object bitmap to an expected bitmap.
obj_check_gui Compares current GUI data to expected GUI data.
obj_check_info Checks the value of an object property.
obj_click_on_text Clicks on text in an object.
obj_drag Begins dragging an object.
obj_drop Ends dragging an object.
obj_exists Checks if an object is displayed.
obj_find_text Returns the location of a string within an object.
obj_get_desc Returns an object's physical description.
obj_get_info Returns the value of an object property.
obj_get_text Reads text from an object.
obj_highlight Highlights an object.
obj_mouse_click Clicks on an object.
obj_mouse_dbl_click Double-clicks on an object.
obj_mouse_drag Drags the mouse within an object.
obj_mouse_move Moves the mouse within an object.
obj_move_locator_text Moves the mouse to a string in an object.
obj_type Sends keyboard input to an object.
obj_wait_bitmap Waits for an object bitmap.
obj_wait_info Waits for the value of an object property.
edit_activate Double-clicks an object in an Oracle application.
edit_set_focus Focuses on an object in an Oracle application.
lov_get_item Retrieves an item from a list of values in an Oracle application.
lov_select_item Selects an item from a list of values in an Oracle application.
datawindow_get_info Retrieves the value of a DataWindow object property.
datawindow_text_click Clicks a DataWindow text object.
datawindow_text_dbl_click Double-clicks a DataWindow text object.
scroll_check_info Checks the value of a scroll property.
scroll_check_pos Checks the current position of a scroll.
scroll_drag Drags a scroll to the specified location.
scroll_drag_from_min Scrolls the specified distance from the minimum position.
scroll_get_info Returns the value of a scroll property.
scroll_get_max Returns the value of a scroll at its maximum (end) position.
scroll_get_min Returns the value of the scroll at its minimum (start) position.
scroll_get_selected Returns the minimum and maximum values of the selected range on a
slider.
scroll_get_pos Returns the current scroll position.
scroll_line Scrolls the specified number of lines.
scroll_max Sets a scroll to the maximum (end) position.
scroll_min Sets a scroll to the minimum (start) position.
scroll_page Moves a scroll the specified number of pages.
scroll_wait_info Waits for the value of a scroll property.
siebel_click_history Clicks the history button.
siebel_connect_repository Connects to the Siebel repository database.
siebel_get_active_applet Returns the active applet name.
siebel_get_active_buscomp Returns the active business component name.
siebel_get_active_busobj Returns the active business object name.
siebel_get_active_control Returns the active control name.
siebel_get_active_view Returns the active view name.
siebel_get_chart_data Returns the legend data and chart values from the specified chart.
siebel_get_control_value Returns the active control value.
siebel_goto_record Navigates to the specified record.
siebel_navigate_view Navigates to the specified view.
siebel_obj_get_info Returns the value of a single Siebel object property from the Siebel
repository database.
siebel_obj_get_properties Returns all properties of a Specified siebel object in the Siebel
repository database.
siebel_select_alpha Selects a letter button from the alpha tab bar.
siebel_set_active_applet Sets the specified applet as the active applet.
siebel_set_active_control Sets the specified control as the active control.
siebel_set_control_value Sets a new value for the active control.
siebel_terminate Closes the Siebel application.
spin_get_info Returns the value of a spin property.
spin_get_pos Returns the position of a spin object.
spin_get_range Returns the minimum and maximum positions of a spin.
spin_max Sets a spin to its maximum value.
spin_min Sets a spin to its minimum value.
spin_next Sets a spin to its next value.
spin_prev Sets a spin to its previous value.
spin_set Sets a spin to the specified value.
spin_up Scrolls a spin control up the specified number of times.
spin_wait_info Waits for the value of a spin property.
static_check_info Checks the value of a static text object property.
static_check_text Checks the contents of a static text object.
static_get_infoReturns the value of a static text property.
static_get_text Returns the contents of a static text object.
static_wait_info Waits for the value of a static text property.
statusbar_get_field_num Returns the numeric index of a field on a status bar.
statusbar_get_info Returns the value of a status bar property.
statusbar_get_text Reads text from a field on a status bar.
statusbar_wait_info Waits for the value of a status bar property.
button_wait_info Waits for the value of a button property.
edit_wait_info Waits for the value of an edit property.
list_wait_info Waits for the value of a list property.
menu_wait_info Waits for the value of a menu property.
obj_wait_info Waits for the value of an object property.
scroll_wait_info Waits for the value of a scroll property.
spin_wait_info Waits for the value of a spin property.
static_wait_info Waits for a the value of a static text property.
statusbar_wait_info Waits for the value of a status bar property.
tab_wait_info Waits for the value of a tab property.
win_wait_info Waits for the value of a window property.
tab_get_info Returns the value of a tab property.
tab_get_item Returns the name of a tab item.
tab_get_selected Returns the name of the selected tab item.
tab_select_item Selects a tab item.
tab_wait_info Waits for the value of a tab property.
tbl_activate_cell Double-clicks the specified cell in a table.
tbl_activate_col Double-clicks the specified column.
tbl_activate_header Double-clicks the specified column header in a table.
tbl_activate_row Double-clicks the specified row.
tbl_deselect_col Deselects the specified column.
tbl_deselect_cols_range Deselects the specified range of columns.
tbl_deselect_row Deselects the specified row.
tbl_deselect_rows_range Deselects the specified range of rows.
tbl_extend_col Adds a column to the currently selected columns.
tbl_extend_cols_range Adds columns to the currently selected columns.
tbl_extend_row Adds a row to the currently selected rows.
tbl_extend_rows_range Adds rows to the currently selected rows.
tbl_get_cell_data Retrieves the contents of the specified cell from a table.
tbl_get_cols_count Retrieves the number of columns in a table.
tbl_get_column_nameRetrieves the column header name of the specified column in a table.
tbl_get_column_names Returns the names and number of columns in a table for
PowerBuilder applications.
tbl_get_rows_count Retrieves the number of rows in the specified table.
tbl_get_selected_cell Returns the cell currently in focus in a table.
tbl_get_selected_row Returns the row currently selected in a table.
tbl_select_cells_range Selects the specified range of cells.
tbl_select_col_header Selects the specified column header of a table.
tbl_select_cols_range Selects the specified range of columns.
tbl_select_rows_range Selects the specified range of rows
tbl_set_cell_data Sets the contents of a cell to the specified text in a table.
tbl_set_cell focus Sets the focus to the specified cell in a table.
tbl_set_selected_cell Selects the specified cell in a table.
tbl_set_selected_col Selects the specified column in a table.
tbl_set_selected_row Selects the specified row in a table.
date_check Checks all dates in the current screen of a terminal emulator application.
date_set_attr Sets the record configuration mode for a field.
date_set_auto_date_verify Automatically generates a date checkpoint for the current screen in
a terminal emulator application.
date_set_capture_mode Determines how WinRunner captures dates in terminal emulator
applications.
TE_add_screen_name_location Instructs WinRunner where to look for the logical name of
a screen.
TE_bms2gui Teaches WinRunner the user interface from a BMS file.
TE_check_text Captures and compares the text in a terminal emulator window.
TE_create_filter Creates a filter in the test database.
TE_define_sync_keys Sets keys that enable automatic synchronization in type, win_type and
obj_type commands.
TE_delete_filter Deletes a specified filter from the test database.
TE_edit_field Inserts text into an unprotected field.
TE_edit_hidden_field Inserts text into a hidden field.
TE_edit_screen Types a string in the specified location in a screen.
TE_find_text Returns the location of a specified string.
TE_force_send_key Defines a key causing a screen to change.
TE_get_active_filter Returns the coordinates of a specified active filter.
TE_get_auto_reset_filters Indicates whether or not filters are automatically deactivated at the
end of a test run.
TE_get_auto_verify Indicates whether automatic text verification is on or off.
TE_get_cursor_position Returns the position of the cursor.
TE_get_field_content Returns the contents of a field to a variable.
TE_get_filter Returns the properties of a specified filter.
TE_get_merge_rule Returns the rule for merging fields.
TE_get_refresh_time Returns the time WinRunner waits for the screen to refresh.
TE_get_screen_name_location Returns the screen name location.
TE_get_sync_time Returns the system synchronization time.
TE_get_text Reads text from screen and stores it in a string.
TE_get_timeout Returns the current synchronization time.
TE_merge_fields Sets the rule for merging fields.
TE_reset_all_filters Deactivates all filters in a test.
TE_reset_all_force_send_key Deactivates the execution of TE_force_send_key functions.
TE_reset_all_merged_fields Deactivates the merging of fields.
TE_reset_filter Deactivates a specified filter.
TE_reset_screen_name_location Resets the screen name location to 0.
TE_send_key Sends to the mainframe the specified F-key function.
TE_set_auto_reset_filters Deactivates the automatic reset of filters when a test run is
completed.
TE_set_auto_transaction Defines a recorded TE_wait_sync statement as a transaction.
TE_set_auto_verify Activates/deactivates automatic text verification.
TE_set_BMS_name_tag Changes a name tag that appears in your BMS file.
TE_set_cursor_position Defines the position of the cursor.
TE_set_field Specifies the field that will receive subsequent input.
TE_set_filter Creates and activates a filter.
TE_set_filter_mode Specifies whether to assign filters to all screens or to the current screen.
TE_set_record_method Specifies the recording method for operations on terminal emulator
objects.
TE_set_refresh_time Sets the interval that WinRunner waits for the screen to refresh.
TE_set_screen_name_location Resets the screen name location to 0 and instructs
WinRunner where to look for the logical name of a
screen.
TE_set_sync_time Defines the system synchronization time.
TE_set_timeout Sets the maximum time WinRunner waits for a response from the server.
TE_set_trailing Determines whether WinRunner types spaces and tabs in fields during test
execution.
TE_user_attr_comment Enables a user to add a user-defined comment property to the
physical description of fields in the GUI map.
TE_user_reset_all_attr_comment Resets all user-defined comment properties.
TE_wait_field Waits for a specified string in a specified field to appear on screen.
TE_wait_string Waits for a string to appear on screen.
TE_wait_sync Instructs WinRunner to wait for the terminal emulator screen to be redrawn.
obj_click_on_text Clicks on text in an object.
obj_find_text Returns the location of a string in an object.
obj_get_text Reads text from an object.
obj_move_locator_text Moves the mouse to a string in an object.
win_find_text Returns the location of a string in a window.
win_click_on_text Clicks on text in a window.
win_get_text Reads text from a window.
win_move_locator_text Moves the mouse to a string in a window.
toolbar_button_press Clicks on a toolbar button.
toolbar_get_button Returns the name of a toolbar button.
toolbar_get_button_info Returns the value of a toolbar button property.
toolbar_get_button_num Returns the position of a toolbar button.
toolbar_get_buttons_count Returns the number of buttons on a toolbar.
toolbar_select_item Selects an item from a menu-like toolbar, as in Microsoft Internet Explorer
4.0 or the Start menu in Windows 98.
phone_append_text Appends the specified text string to the current contents of the phone
editor.
phone_edit_set Replaces the contents of the phone editor with the specified text string
phone_get_name Returns the model name of the specified phone.
phone_GUI_load Loads the GUI map for the specified Phone.com phone.
phone_key_click Clicks a phone key.
phone_navigate Directs the phone to connect to the specified site.

phone_sync Recorded after any phone navigation on the Nokia emulator, and instructs
WinRunner to wait until the phone is ready to handle the next operation.
web_browser_invoke Invokes the browser and opens a specified site.
web_cursor_to_image Moves the cursor to an image on a page.
web_cursor_to_label Moves the cursor to a label on a page.
web_cursor_to_link Moves the cursor to a link on a page.
web_cursor_to_obj Moves the cursor to an object on a page.
web_event Runs an event on a specified object.
web_file_browse Clicks a browse button.
web_file_set Sets the text value in a file-type object.
web_find_text Returns the location of text within a page.
web_frame_get_text Retrieves the text content of a page.
web_frame_get_text_count Returns the number of occurrences of a regular expression in a
page.
web_frame_text_exists Checks whether the specified text string is found in a frame.
web_get_run_event_mode Returns the current run mode.
web_get_timeout Returns the maximum time that WinRunner waits for response from the
web.
web_image_click Clicks a hypergraphic link or an image.
web_label_click Clicks the specified label.
web_link_click Clicks a hypertext link.
web_link_valid Checks whether a URL name of a link is valid (not broken).
web_obj_get_child_item Returns the description of the children in an object.
web_obj_get_child_item_count Returns the count of the children in an object.
web_obj_get_info Returns the value of an object property.
web_obj_get_text Returns a text string from an object.
web_obj_get_text_count Returns the number of occurrences of a regular expression string in
an object.

web_obj_text_exists Returns a text value if it is found in an object.

web_refresh Resets WinRunner’s connection to the specified frame.
web_restore_event_default Resets all events to their default settings.
web_set_event Sets the event status.
web_set_run_event_mode Sets the event run mode.
web_set_timeout Sets the maximum time WinRunner waits for a response from the web.
web_set_tooltip_color Sets the colors for the WebTest ToolTip.
web_sync Waits for the navigation of a frame to be completed.
web_tbl_get_cell_data Retrieves the contents of the specified cell from a Web table.
web_url_valid Checks whether a URL is valid.
The following table functions are available for WebTest:
tbl_get_cell_data Retrieves the contents of the specified cell from a table.
tbl_get_cols_count Retrieves the number of columns in a table.
tbl_get_column_nameRetrieves the column header name of the specified column
tbl_get_rows_count Retrieves the number of rows in the specified table.
The following password function is available for WebTest:
web_password_encrypt Encrypts a password on a Web page.
set_window Specifies the window to receive input, according to the window's logical name.
set_window Specifies a window to receive input, according to the window's physical
description.
win_activate Activates a window.
win_check_bitmap Compares a current window bitmap to an expected bitmap.
win_check_gui Compares current GUI data to expected GUI data.
win_check_info Checks the requested window property.
win_click_help Clicks the help button in a window title bar.
win_click_on_text Clicks on text in a window.
win_close Closes a window.
win_drag Drags an object from a source window.
win_drop Drops an object on a target window.
win_exists Checks whether a window is displayed.
win_find_text Returns the location of a string in a window.
win_get_desc Returns the physical description of a window.
win_get_info Returns the value of a window property.
win_get_text Reads text from a window.
win_highlight Highlights a window.
win_max Maximizes a window.
win_min Minimizes a window to an icon.
win_mouse_click Clicks in a window.
win_mouse_dbl_click Double-clicks in a window.
win_mouse_drag Drags the mouse in a window.
win_mouse_move Moves the mouse in a window.
win_move Moves a window to a new absolute location.
win_move_locator_text Moves the mouse to a string in a window.
win_open Opens a window.
win_resize Resizes a window.
win_restore Restores a window from a minimized or maximized state to its previous size.
win_type Sends keyboard input to a window.
win_wait_bitmap Waits for a window bitmap.
win_wait_info Waits for the value of a window property.
Standard functions
atan2 Returns the arctangent of y/x, in radians.
cos Returns the cosine of an angle, in radians.
exp Calculates the exponential function of ex.
int Returns the integer part of a real number.
log Returns a natural logarithm.
rand Returns a pseudo-random real number.
sin Calculates the sine of an angle.
sqrt Returns the square root of its argument.
srand Defines a seed parameter for the rand function.
delete Removes an element from an array.
split Divides an input string into fields, stores them in an array, and indicates the number of
fields generated.
call Invokes a test from within another test script.
call_chain_get_attr Obtains information about a test or function in the current call chain.
call_chain_get_depth Returns the number of items in the current call chain.
call_close Invokes a test from within a script and closes the test when the test is completed.
call_ex Invokes an Astra QuickTest test from within a WinRunner test script.
return Returns a value to the calling function or test.
texit Stops execution of the current test.
treturn Stops a called test and returns control to the calling test.
load Loads a compiled module into memory.
reload Removes a compiled module from memory and loads it again.
unload Removes a compiled module or selected functions from memory.
define_object_exception Defines a GUI object exception.
define_popup_exception Defines a popup window exception.
define_tsl_exception Defines a TSL exception.
exception_off Deactivates handling for an exception.
exception_off_all Deactivates handling of all exceptions.
exception_on Enables detection and handling of a previously defined exception.
file_close Closes a file opened with file_open.
file_compare Compares the contents of two files.
file_getline Reads a line from a file.
file_open Opens a file for reading or printing, or creates a new file.
file_printf Prints formatted output to a file.
pause Pauses a test and displays a message.
report_msg Inserts a message in a test report.
sprintf Returns a formatted string to a variable.
str_map_logical_to_visual Converts a logical string to a visual string or vice-versa.
The following functions are available for LoadRunner GUI Vusers only.
declare_rendezvous Declares a rendezvous.
declare_transaction Declares a transaction.
end_transaction Marks the end of a transaction for performance analysis.
error_message Sends an error message to the controller.
get_host_name Returns the name of a host.
get_master_host_name Returns the name of the controller's host.
lr_whoami Returns information about the Vuser executing the script.
output_message Sends a message to the controller.
rendezvous Sets a rendezvous point in a Vuser script.
start_transaction Marks the beginning of a transaction for performance analysis.
user_data_point Records a user-defined data sample.
eval Evaluates and executes the enclosed TSL statements.
getenv Returns the value of any environment variable, as defined in the [WrEnv] section of
wrun.ini or in the WinRunner run-time environment.
load_16 dll Performs a runtime load of a 16-bit Dynamic Link Library.
load_dll Performs a runtime load of a Dynamic Link Library.
nargs Returns the number of arguments passed to the function or test.
tl_step Divides a test script into sections and inserts a status message in the test results for the
previous section. When WinRunner is connected to a TestDirector project, the message is
inserted in the TestDirector_"step" table for each statement.
tl_step_once Divides a test script into sections and inserts a status message in the test results
for the previous section. When WinRunner is connected to a TestDirector
project, the message is inserted in the TestDirector "step" table once for
each step name.
unload_16_dll Unloads a 16-bit DLL from memory.
unload_dll Unloads a DLL from memory.
dos_system Executes a DOS system command.
invoke_application Invokes a Windows application from within a test script.
password_edit_set Sets the value of a password edit field to a given value.
password_encrypt Encrypts a plain password.
web_password_encrypt Encrypts a password on a Web page.
qt_force_send_key Instructs WinRunner 2000 to recognize an edit field which prompts a
screen change when information is inserted.
qt_reset_all_force_send_key Negates screen change configurations previously made using the
qt_force_send_key function.
ascii Returns the ASCII code of the first character in a string.
compare_text Compares two strings.
index Indicates the position of one string within another.
length Counts characters in a string.
match Finds a regular expression in a string.
split Divides an input string into fields and stores them in an array.
sprintf Returns a formatted string to a variable.
substr Extracts a substring from a given string.
tolower Converts uppercase characters to lowercase.
toupper Converts lowercase characters to uppercase.
To add the TDAPI functions to WinRunner’s Function Generator, run the tdapi test in the lib
folder of your WinRunner installation directory.
For explanations and examples of all TDAPI functions, refer to the TestDirector API Help.
Click a TDAPI function below to open the TestDirector API Help to the appropriate screen.
TDAPI AddStepToRun
TDAPI AddTestToCycle
TDAPI BugListMove
TDAPI Connect
TDAPI CreateBug
TDAPI CreateBugList
TDAPI CreateCycle
TDAPI CreateCycleList
TDAPI CreateDesStep
TDAPI CreateDesStepList
TDAPI CreateRun
TDAPI CreateRunList
TDAPI CreateStepList
TDAPI CreateTDDatabasesList
TDAPI CreateTest
TDAPI CreateTestInCycleList
TDAPI CreateTestList
TDAPI CreateUser
TDAPI CreateUserList
TDAPI CycleExists
TDAPI CycleListMove
TDAPI DeleteBug
TDAPI DeleteCycle
TDAPI DeleteDesStep
TDAPI DeleteRun
TDAPI DeleteStep
TDAPI DeleteTest
TDAPI DeleteTestFromCycle
TDAPI DeleteUser
TDAPI DesStepListMove
TDAPI Disconnect
TDAPI FindTestByPath
TDAPI FindTestBySubjectPath
TDAPI GetBugFieldSize
TDAPI GetBugValue
TDAPI GetCategoryTreeRoot
TDAPI GetCycleFieldSize
TDAPI GetCyclesForTest
TDAPI GetCycleValue
TDAPI GetDatabaseNameFromList
TDAPI GetDesStepFieldSize
TDAPI GetDesStepValue
TDAPI GetFieldProperty
TDAPI GetLastErrorString
TDAPI GetRunFieldSize
TDAPI GetRunValue
TDAPI GetStackErrorString
TDAPI GetStepFieldSize
TDAPI GetStepValue
TDAPI GetTestFieldSize
TDAPI GetTestFullPath
TDAPI GetTestInCycleFieldSize
TDAPI GetTestInCycleValue
TDAPI GetTestSubjectPath
TDAPI GetTestValue
TDAPI GetUserFieldSize
TDAPI GetUserValue
TDAPI RunListMove
TDAPI SetBugValue
TDAPI SetCycleValue
TDAPI SetDesStepValue
TDAPI SetRunValue
TDAPI SetStepValue
TDAPI SetTestInCycleValue
TDAPI SetTestValue
TDAPI SetUserValue
TDAPI StepListMove
TDAPI TestExists
TDAPI TestInCycleExists
TDAPI TestInCycleListMove
TDAPI TestListMove
TDAPI TreeAddNode
TDAPI TreeChanged
TDAPI TreeCreateRoot
TDAPI TreeGetChild
TDAPI TreeGetNodeAttribute
TDAPI TreeGetNumberOfChildren
TDAPI TreeGetRoot
TDAPI TreeGetSubjectIdFromPath
TDAPI UserExists
TDAPI UserListMove
tddb_get_step_value Returns the value of a field in the "dessteps" table in a TestDirector
project.
tddb_get_test_value Returns the value of a field in the "test" table in a TestDirector project.
tddb_get_testset_value Returns the value of a field in the "testcycl" table in a TestDirector
project.
tddb_load_attachment Loads a file attachment of a test and returns the location of the loaded
attachment.
tl_step Divides a test script into sections and inserts a status message in the test results for the
previous section. When WinRunner is connected to a TestDirector project, the message is
inserted in the TestDirector_"step" table for each statement.
tl_step_once Divides a test script into sections and inserts a status message in the test results
for the previous section. When WinRunner is connected to a TestDirector
project, the message is inserted in the TestDirector "step" table once for
each step name.
get_aut_var returns the value of a variable that determines how WinRunner learns descriptions
of objects, records tests, and runs tests on Java applets or applications.
getvar Returns the value of a testing option/configuration parameter.
set_aut_var Sets how WinRunner learns descriptions of objects, records tests, and runs tests
on Java applets or applications.
setvar Sets the value of a testing option/configuration parameter.
end_transaction Marks the end of a transaction for performance analysis.
get_time Returns the current system time.
pause Pauses test execution and displays a message.
start_transaction Marks the beginning of a transaction for performance analysis.
time_str Converts the integer returned by get_time to a string.
wait Causes test execution to pause for the specified amount of time.
Customization function
add_cust_record_class Associates a custom record function or a logical name function
with a custom class.
add_record_attr Registers a custom property.
add_record_message Adds a message to the list of Windows messages that WinRunner
processes.
delete_record_attr Removes a custom property.
generator_add_category Adds a category to the Function Generator.
generator_add_function Adds a function to the Function Generator.
generator_add_function_to_category Adds a function defined in the Function Generator to a
category.
generator_add_subcategory Adds a subcategory to a category in the Function Generator.
generator_set_default_function Sets a default function for a Function Generator category.
gui_ver_add_check Registers a new check for a GUI checkpoint.
gui_ver_add_check_to_class Adds a check to an object class, which can be viewed in the GUI
Checkpoint dialog boxes.
gui_ver_add_class Adds a checkpoint for a new object class.
gui_ver_set_default_checks Sets default checks for a GUI object class.
create_browse_file_dialog Displays a browse dialog box from which the user selects a file.
create_custom_dialog Creates a custom dialog box.
create_input_dialog Creates a dialog box with an edit field for use in interactive test execution.
create_list_dialog Creates a dialog box with a list of items for use in interactive test
execution.
create_password_dialog Creates a password dialog box.