BSAPI
Public Types | Public Member Functions
SErrorCallbackI Class Reference

An interface that allows to receive error, warning and log messages. More...

#include <bsapi.h>

Inheritance diagram for SErrorCallbackI:
SErrorHandlerI

List of all members.

Public Types

enum  message_type { mtError, mtWarning, mtLog }
 Message type. More...

Public Member Functions

virtual void BSAPI_METHOD OnTextMessage (SUnknownI *pSender, message_type type, unsigned int messageId, const char *pMessage)=0
 This function receives error, warning or log message.

Detailed Description

An interface that allows to receive error, warning and log messages.

In BSAPI, the information about error passed from each function is rather simple - true if the function finished correctly, false in case of error (or 0 in case of error if a pointer should be returned). The detailed information about error is sent to an error handler or printed to standard output if no error handler was set for an instance. Almost all classes allows to set an error handler by the SetErrorHandler function. The error handler can also receive warning and log messages.

Examples:

error_handler.cpp, gid.cpp, kws.cpp, lid.cpp, offlinerec3.cpp, sid.cpp, vpcompare.cpp, and vpextract.cpp.


Member Enumeration Documentation

Message type.

Enumerator:
mtError 

Error message.

mtWarning 

Warning.

mtLog 

Log message.


Member Function Documentation

virtual void BSAPI_METHOD SErrorCallbackI::OnTextMessage ( SUnknownI pSender,
message_type  type,
unsigned int  messageId,
const char *  pMessage 
) [pure virtual]

This function receives error, warning or log message.

Parameters:
pSenderpointer to the caller object
typemessage type - mtError, mtWarning or mtLog
messageIdunique message identification number
pMessagemessage string
Examples:
error_handler.cpp, gid.cpp, kws.cpp, lid.cpp, offlinerec3.cpp, sid.cpp, vpcompare.cpp, and vpextract.cpp.

The documentation for this class was generated from the following file: