# OS_CheckStack

## Syntax

      #include <nitro/os.h>

      void OS_CheckStack( const OSThread* thread );

## Arguments

thread | The thread to be checked.

## Return Values

None.

## Description

Checks for stack overflow with the specified thread

This function checks the magic numbers written in the stack's highest and lowest locations (and, if set, the warning level location set by the user) to see if they have been rewritten (if the section has been used one or more times). If they have been used, `OS_Panic()` will be called and the program will stop.

This function is for debugging, so it will not effect the FINALROM.

## See Also

`OS_SetThreadStackWarningOffset`, `OS_GetStackStatus`

## Revision History

2005/09/06 Added const to OSThread* type argument.
2004/04/29 Deleted precaution about threads which cannot be checked.
2004/02/25 Added a precaution about threads which cannot be checked.
2004/01/21 Initial version.

CONFIDENTIAL