IoGetRemainingStackSize function

The IoGetRemainingStackSize routine returns the current amount of available kernel-mode stack space.

Syntax

ULONG_PTR IoGetRemainingStackSize(

);

Parameters

This function has no parameters.

Return Value

IoGetRemainingStackSize returns the number of bytes of stack space in the current thread context.

Remarks

Highest-level drivers, such as file systems, can call this routine, particularly drivers that use recursive code paths. Such a driver would call IoGetRemainingStackSize before launching a recursion to determine whether it should continue processing on an alternate code path.

For Windows Server 2003 Service Pack 1 (SP1) and later versions of Windows, callers of IoGetRemainingStackSize can be running at any IRQL. For earlier versions of Windows, the caller must be running at IRQL <= APC_LEVEL.

Requirements

   
Windows version Available starting with Windows 2000.
Target Platform Desktop
Header wdm.h (include Wdm.h, Ntddk.h, Ntifs.h)
IRQL See Remarks section.

See Also

IoGetInitialStack

IoGetStackLimits