/*
 * $Id: iamidle.txt 15102 2010-07-14 12:48:39Z vszakats $
 */

/*  $DOC$
 *  $FUNCNAME$
 *     FT_IAmIdle()
 *  $CATEGORY$
 *     DOS/BIOS
 *  $ONELINER$
 *     Inform the operating system that the application is idle.
 *  $SYNTAX$
 *     FT_IAmIdle() -> lSuccess
 *  $ARGUMENTS$
 *     None
 *  $RETURNS$
 *     .T. if supported, .F. otherwise.
 *  $DESCRIPTION$
 *     Some multitasking operating environments (e.g. Windows or OS/2) can
 *     function more efficiently when applications release the CPU during
 *     idle states.  This function allows you "announce" to the operating
 *     system that your application is idle.
 * 
 *     Note that if you use this function in conjunction with FT_OnIdle(),
 *     you can cause Clipper to automatically release the CPU whenever
 *     Clipper itself detects an idle state.
 *  $EXAMPLES$
 *     while inkey() != K_ESC
 *        FT_IAmIdle()         // Wait for ESC and announce idleness
 *     end
 * 
 *     * Here's another way to do it:
 * 
 *     FT_OnIdle( {|| FT_IAmIdle()} )
 * 
 *     Inkey( 0 )              // Automatically reports idleness until key
 *                             // is pressed!
 *  $SEEALSO$
 *     FT_OnIdle()
 *  $END$
 */
