Yield function and statement (LotusScript® Language)

Transfers control to the operating system during script execution.



DoEvents is acceptable in place of Yield.

Return value

The Yield function returns 0 as an Integer value.


The Yield function and statement transfer control to the operating system, so that it can process the events in its queue. In Windows, the operating system does not return control until it has processed all outstanding events, including those generated by a SendKeys statement.

The Yield function and statement are legal within a procedure or a class. They are not legal at the module level.

You can call the function as either Yield or Yield().