api_stop_modeller
List of: Functions
Subjects: Modeler Control
Contents: Kernel

Action: Terminates modeler and releases memory.

Prototype: outcome api_stop_modeller ();

Includes: #include "kernel/acis.hxx"

#include "kernel/kernapi/api/api.hxx"

#include "kernel/kernapi/api/kernapi.hxx"

Description: This API attempts to release all memory allocated by ACIS. The application should not attempt to reference any data returned by earlier calls to APIs or Direct Interface routines after calling api_stop_modeller.


No other APIs should be called until api_start_modeller is called again.


This function returns a non-zero FREELIST_IN_USE outcome indicating remaining memory allocations in the internal freestore. This is due to the size-based freelist strategy implemented in the MMGR component, which allows global object constructors to use the internal heap. The memory is not returned to freestore until the objects are destructed, which occurs after program execution and consequently after api_stop_modeller. Directly after an api_start_modeller call and prior to an api_stop_modeller call, compare the number of objects already in freestore with the count still remaining. The current count of committed objects in ACIS internal freestore is returned by the check_free_lists function defined in mmgr/mmgrhusk/freelist.hxx.

Library: kernel

Filename: kern/kernel/kernapi/api/kernapi.hxx

Effect: Read-only
PDF/KERN/16FNA.PDF
HTM/DATA/KERN/KERN/16FNA/0161.HTM