Difference between revisions of "TestHeapConsistency"
m (adding doc status category) |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | [[Category: Internal Functions]] | |
| + | [[Category: Memory management]] | ||
[[Category:Doc Status C]] <!-- For Lumina use, do not change --> | [[Category:Doc Status C]] <!-- For Lumina use, do not change --> | ||
| − | Performs series of internal tests on the internal memory heap to detect whether any internal memory corruption has occurred. This is a diagnostic routine used for detecting and diagnosing bugs in | + | == Function TestHeapConsistency == |
| + | Performs series of internal tests on the internal memory heap to detect whether any internal memory corruption has occurred. This is a diagnostic routine used for detecting and diagnosing bugs in Analytica itself. Theoretically, heap corruption should never occur. If any heap corruption is detected, you should save your work, exit and restart Analytica, and then report any activities that may have lead up to the detected corruption to [mailto:support@lumina.com support@lumina.com]. | ||
| − | For the most part, this function is intended for internal Lumina usage and is not officially supported. | + | For the most part, this function is intended for internal [http://lumina.com Lumina] usage and is not officially supported. |
== Declaration == | == Declaration == | ||
| − | + | :[[TestHeapConsistency]](ShowErr: optional boolean atomic = false) | |
| − | |||
Parameters: | Parameters: | ||
| − | + | ;ShowErr: If <code>True</code>, an error is reported if any corruption is detected. | |
== Return Value == | == Return Value == | ||
| + | Returns <code>1</code> if everything appears to be okay (self-consistent), <code>0</code> if corruption has been detected. | ||
| − | + | When the return value is <code>0</code>, there is definitely corrupted memory. If the return value is <code>1</code>, this indicates only that no corruption was detected. It is possible that some corruption could go undetected, since the function examines only the consistency of the heap structure. | |
| − | + | If there is corruption of the heap, there is also a remote possibility that the function could hang or crash while being evaluated. | |
| − | + | ==See Also== | |
| + | * [[Memory usage and management]] | ||
Latest revision as of 01:16, 11 February 2016
Function TestHeapConsistency
Performs series of internal tests on the internal memory heap to detect whether any internal memory corruption has occurred. This is a diagnostic routine used for detecting and diagnosing bugs in Analytica itself. Theoretically, heap corruption should never occur. If any heap corruption is detected, you should save your work, exit and restart Analytica, and then report any activities that may have lead up to the detected corruption to support@lumina.com.
For the most part, this function is intended for internal Lumina usage and is not officially supported.
Declaration
- TestHeapConsistency(ShowErr: optional boolean atomic = false)
Parameters:
- ShowErr
- If
True, an error is reported if any corruption is detected.
Return Value
Returns 1 if everything appears to be okay (self-consistent), 0 if corruption has been detected.
When the return value is 0, there is definitely corrupted memory. If the return value is 1, this indicates only that no corruption was detected. It is possible that some corruption could go undetected, since the function examines only the consistency of the heap structure.
If there is corruption of the heap, there is also a remote possibility that the function could hang or crash while being evaluated.
Enable comment auto-refresher