OSIsMainCore

Syntax

#include <cafe/os.h>

BOOL OSIsMainCore(void);

Parameters

None.

Return Values

TRUE, currently executing processor core is the main operating system core. FALSE, currently executing processor core is not the main operating system core.

Description

Returns whether the core which executes OSIsMainCore is the main operating system core. The main operating system core is the only core capable of running the OS. The sub-cores are typically used to run MPTasks.

Do Not Call From

None.

See Also

OSGetCoreCount
OSGetCoreCoreId

Revision History

2013/05/08 Automated cleanup pass.
2012/05/14 Match actual prototype.
2010/08/23 Initial version.


CONFIDENTIAL