# OS_CheckStack

## C Specification

      #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 number written in the stack's top and bottom positions (and, if set, the user warning level position). It checks if it has been rewritten (this portion was used one or more times). If it is being used, the program that called `OS_Panic()` is stopped.

This function is for debugging, so it will not do anything on the FINALROM.

## See Also

`OS_SetThreadStackWarningOffset`, `OS_GetStackStatus`

## Revision History

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