Files
harbour-core/harbour/contrib/hbnf/ftidle.c
Viktor Szakats 8012581cbe 2007-12-01 02:42 UTC+0100 Viktor Szakats (harbour.01 syenar.hu)
- contrib/libct
   + contrib/hbct
   - contrib/libgt
   + contrib/hbgt
   - contrib/libnf
   + contrib/hbnf
   * contrib/Makefile
   * contrib/make_b32_all.bat
   * contrib/make_vc_all.bat
   * utils/hbmake/hbmutils.prg
     * Contrib lib rename continued.
2007-12-01 01:43:13 +00:00

69 lines
1.7 KiB
C

/*
* $Id$
*/
/*
* File......: IDLE.C
* Author....: Ted Means (with much gratitude to Robert DiFalco)
* CIS ID....: 73067,3332
*
* This function is an original work by Ted Means and is placed in the
* public domain.
*
* Modification history:
* ---------------------
*
* Rev 1.0 01 Jan 1995 03:01:00 TED
* Initial release
*
*/
#include "hbdefs.h"
#include "hbapi.h"
/* $DOC$
* $FUNCNAME$
* FT_Idle()
* $CATEGORY$
* Event
* $ONELINER$
* Generate an idle event to allow incremental garbage collection.
* $SYNTAX$
* FT_Idle()
* $ARGUMENTS$
* None
* $RETURNS$
* NIL
* $DESCRIPTION$
* During memory-intensive operations that do not generate much in
* the way of idle states, the Clipper runtime may not get a chance to
* perform garbage collection of discarded memory. This can eventually
* lead to any of a variety of memory-related internal errors.
*
* This function attempts to alleviate the problem by providing a
* mechanism by which an idle event can be artifically generated at
* will. The idle event will cause the CA-Clipper runtime to perform
* an incremental memory scavenge.
*
* This function makes use of an undocumented interal routine. If this
* this fact makes you uncomfortable then don't use this function, you
* miserable jello-spined lump of human debris.
* $EXAMPLES$
*
* while Whatever // Some batch process
*
* Something() // Create 'n' discard a bunch of stuff
*
* FT_Idle() // Take out the garbage
*
* end
* $SEEALSO$
* FT_OnIdle()
* $END$
*/
HB_FUNC(FT_Idle)
{
hb_idleState();
}