LeoClearQueue LeoClearQueue (function)

Clears the Leo Manager's command queue

Syntax

#include <PR/leo.h>     /* leo.h */

s32 LeoClearQueue(void); 

Description

It clears the Leo Manager's command queue. Commands that are in the midst of execution continue to execute unchanged.

LEO_ERROR_COMMAND_TERMINATED is returned when all the commands are cleared from the queue. This function usually has a normal termination.

The following are the possible return values. Usually, you don't need to check for the return values.

-1

Leo Manager has not started yet.

LEO_ERROR_GOOD

Normal execution occurred. A normal termination is returned even when there are no messages waiting in the command queue.

See Also

Leo*CreateLeoManager, LeoReset

Revision History

04/30/1999 Changed Format