OS_RestoreFunctionCost

Syntax

#include <nitro/os.h>

BOOL OS_RestoreFunctionCost( BOOL enable );

Arguments

enable The status of the function cost calculation feature to be set (enabled / disabled)

Return Values

The status before this function was called. TRUE indicates that it was enabled. FALSE indicates that it was disabled.

Description

This function enables or disables the function cost calculation feature.

This switch decides whether the function entry and exit (__PROFILE_ENTRY, __PROFILE_EXIT) that are inserted by the profile feature will become enabled. Therefore take note of how you time enable/disable switching. For example, if you call a function called test() when in disabled status, and then enable from within the test() function, consistency will not be possible because it will only store information at __PROFILE_EXIT, even though nothing was done at the function entry (__PROFILE_ENTRY).

Enable / disable switches are set for each cost calculation buffer. Therefore one will not change all.

If this function is compiled for debugging, it will function properly. However, if compiled for the final ROM version (FINALROM) library, it will not do anything.

See Also

OS_InitFunctionCost, OS_EnableFunctionCost, OS_DisableFunctionCost

Revision History

2004/05/18 Initial version.


CONFIDENTIAL