xHarbour Reference Documentation > Function Reference

HB_BackGroundTime()

Queries or changes the wait interval in milliseconds after which the task is executed.

Syntax

HB_BackGroundTime( ( <nTaskHandle> [, <nNewInterval>] ) --> nOldInterval

Arguments

<nTaskHandle>

This is the numeric task handle as returned by HB_BackGroundAdd().

<nNewInterval>

This is an optional numeric value specifying the time interval in milliseconds a background task should wait between two execution cycles. When set to zero, a background task is invoked each time the internal task list is checked for background execution.

Return

The function returns the previous wait interval of the background task as a numeric value. If an invalid task handle id passed, the return value is NIL.

Description

Function HB_BackGroundTime() queries or changes the number of milliseconds after which the task is executed. Normally, the time interval is defined with the second parameter of HB_BackGroundAdd().

Info

See also:	HB_BackGroundActive(), HB_BackGroundAdd(), HB_BackGroundDel(), HB_BackGroundReset(), HB_BackGroundRun()
Category:	Background processing , xHarbour extensions
Source:	rtl\bkgtsks.c
LIB:	xhb.lib
DLL:	xhbdll.dll