NWC24SuspendScheduler

C Specification

#include <revolution/nwc24.h>
s32 NWC24SuspendScheduler( void );

Description

Temporarily suspends the auto-scheduler.
Blocks and waits until the auto-scheduler is paused.

Arguments

None.

Return Values

Returns the suspend counter from before the process' start.

When 0 is returned, it indicates that the auto-schedule was in an executable state before the process began.
When a positive number is returned. it indicates it was paused before the process began.
One of the following is returned when the process fails:

NWC24_ERR_FATAL: fatal error.
NWC24_ERR_INTERNAL_IPC: problem with internal process.
NWC24_ERR_INPROGRESS: scheduler has not started.
NWC24_ERR_MUTEX: there is context indicating another call to the scheduler API and such.

See Also

NWC24TrySuspendScheduler, NWC24ResumeScheduler

Revision History

2006/09/01 Initial version.


CONFIDENTIAL