PathEngine home previous: Interface iErrorHandlernext: Interface iOutputStream
Contents, API Reference, Interfaces, iErrorHandler, handle

iErrorHandler::handle()

Description

This method is called by PathEngine in the case of an error.

Syntax

iErrorHandler::eAction handle(const char* type, const char* description, const char *const* attributes);
        

Parameters

type A C string specifying the type of error. See Error Handlers for an explanation of this parameter.
description A C string containing a human readable description of the error.
attributes A set of attributes relating to the error. See Handling Attributes

Return Value

The client application returns an enumerated value that specified what action PathEngine should take subsequent to the handler returning.
The enumeration is defined as part of the iErrorHandler class definition.

Remarks

See Error Handlers for explanation about PathEngine error handlers.


Documentation for PathEngine release 5.29 - Copyright © 2002-2012 PathEnginenext: Interface iOutputStream