TSLMapLinkErrorCallback Class Reference

Detailed Description

This is an interface class that can be used to intercept calls to place MapLink errors on the MapLink error stack(TSLErrorStack/TSLThreadedErrorStack).

The user can specify which error categories you are interested in when registering the callback with the error stack (TSLErrorStack/TSLThreadedErrorStack).

Public Member Functions
virtual bool	error (TSLErrorCategory category, int errorCode, const char *errorNote, const char *additionalInformation)=0
virtual	~TSLMapLinkErrorCallback ()=0

Constructor & Destructor Documentation

~TSLMapLinkErrorCallback()

TSLMapLinkErrorCallback::~TSLMapLinkErrorCallback ( )

inlinepure virtual

Required to be implemented.

Member Function Documentation

error()

virtual bool TSLMapLinkErrorCallback::error ( TSLErrorCategory category, int errorCode, const char * errorNote, const char * additionalInformation )

pure virtual

This method is called when a MapLink error is placed on the MapLink error stack (TSLErrorStack/TSLThreadedErrorStack).

This callback can be called from multiple threads. MapLink will only issue one call to this method at a time.

The information passed should be copied before returning from the method.

If you return false from this method the error will not be placed on the internal MapLink error stack.

Parameters

category	the TSLErrorCategory of the error being reported.
errorCode	The error code number. This is unique in MapLink (see the .msg files in the config directory).
errorNote	Error information provided by the SDK.
additionalInformation	Additional error information from the .msg file.

Returns

• true The error is added to the MapLink error stack
• false The error is not added to the MapLink error stack.