PathEngine_InitialiseAndObtainRootInterface

Contents, API Reference, Functions, PathEngine_InitialiseAndObtainRootInterface

PathEngine_InitialiseAndObtainRootInterface

Description

Initialises PathEngine and returns the root interface pointer (static and Linux .so linkage).

Syntax

This function is defined in 'SDKRoot/interface/PathEngine_DirectLinkage.h', (included in the source code archives), as follows:

extern "C"
{
iPathEngine*
PathEngine_InitialiseAndObtainRootInterface(iErrorHandler* handler);
}

Parameters

handler

A pointer to an object PathEngine will call to handle errors. This pointer must remain valid until either PathEngine is shut down, or a new handler is set with iPathEngine::setErrorHandler().

Return Value

A pointer to the Interface iPathEngine interface, providing access the core PathEngine run-time functionality.

Remarks

This function is provided for SDK initialisation in the case of either direct linkage to PathEngine as a set of static libraries, or Linux shared object linkage.
Refer to Linking with the SDK for more information about different ways of linking with the SDK.

Normally this function should be called just once.
Calling this function when the SDK is initialised will result in an error being emitted.

The SDK can be shut down explicitly, if desired, by calling PathEngine_ShutDown.
After explicit shutdown, it is then possible to call PathEngine_InitialiseAndObtainRootInterface() again, to reinitialise the SDK.

This function is not thread safe.

next: PathEngine_ShutDown