Home > Language Reference > Windows Management Functions > ClickSpin

ClickSpin

The ClickSpin function clicks a spin control.

Usage

Used to automate a spin control. With a spin control in a dialog, you can click an arrow button to change incrementally the value within its associated numeric box listing the possible values (for example in Print dialog box, Number of copies to print).

Syntax

ret=ClickSpin(<spin_name>, <count>)

Parameters

<spin_name>, string, spin control identifier. Recording mode generates automatically this identifier.

<count>, integer, number of clicks on the arrow button.

Return value

ret, optional numeric return value. If the spin control has been successfully clicked within 30 seconds (this default value can be changed using #ActionTimeout), the function returns 0. If the function fails, the return value is a nonzero value (see Window Functions Error Codes).

Example

ClickSpin("spin1",-2)