xHarbour Reference Documentation > Function Reference

HB_BackGroundRun()

Enforces execution of one or all background tasks.

Syntax

HB_BackGroundRun( [<nTaskHandle>] ) --> NIL

Arguments

<nTaskHandle>

This is the numeric task handle as returned by HB_BackGroundAdd(). If omitted, all background tasks are executed.

Return

The return value is always NIL.

Description

Function HB_BackGroundRun() executes a single background task defined with <nTaskHandle>, or all tasks from the internal task list when no task handle is specified. The function can be used to enforce execution of background tasks during regular program execution or during idle states of a program.

Note:  HB_BackGroundRun() executes the task specified with <nTaskHandle> immediately, even if the wait interval defined for this task has not elapsed, or if the task is not active.

Info

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