xHarbour Reference Documentation > Function Reference

HB_BackGroundActive()

Queries and/or changes the activity of a single background task.

Syntax

HB_BackGroundActive( <nTaskHandle> [, <lNewActive>] ) --> lOldActive

Arguments

<nTaskHandle>

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

<lNewActive>

This is an optional logical value used to change the activity of a background task. Passing .T. (true) activates the background task, and .F. (false) deactivates it.

Return

The function returns the previous activation state of a background task as a logical value.

Description

Function HB_BackGroundActive() queries and optionally changes the activation state of a single background task. If the task handle, as returned from HB_BackGroundAdd(), is valid, the previous value for the activation state is returned. If an invalid task handle is passed, the return value is NIL.

Info

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