PathEngine_ShutDown

Description

Shuts down PathEngine explicitly (static and Linux .so linkage).

Syntax

extern "C"
{
	void PathEngine_ShutDown();
}

Remarks

The host OS will generally take care of cleaning up all allocated resources on process completion, but this method may be called to shutdown PathEngine and release any resources allocated explicitly by PathEngine, before process completion, if this is required.

Note that in certain cases it is possible for memory to be allocated by third party code (such as a compiler supplied standard C library) for things like internal pooling or caching, so in these cases it is possible for some memory to remain allocated after shutdown.

This function is provided to enable explicit SDK shutdown to be requested, in the case of either direct linkage to PathEngine as a set of static libraries, or Linux shared object linkage.
In the case of DLL linkage this method is not available, and the SDK can instead be shutdown when desired by unloading the PathEngine dll.

Calling this function before the SDK has been initialised (with PathEngine_InitialiseAndObtainRootInterface), or after it has already been shut down, will have no effect.

This function is not thread safe.