SErrorCallbackI Class Reference

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

#include <bsapi.h>

List of all members.

Public Types
	mtError
	Error message.
	mtWarning
	Warning.
	mtLog
	Log message.
enum	message_type { mtError, mtWarning, mtLog }
	Message type. More...
Public Member Functions
virtual void BSAPI_METHOD	OnTextMessage (unsigned int iId, message_type type, unsigned int messageId, 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, gender_identification.cpp, keyword_spotting.cpp, language_identification.cpp, and speaker_identification.cpp.

---

Member Enumeration Documentation

enum SErrorCallbackI::message_type

Message type.

Enumerator:

mtError	Error message.
mtWarning	Warning.
mtLog	Log message.

---

Member Function Documentation

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

This function receives error, warning or log message.

Parameters:

	iId	interface identification number of caller
	type	message type - mtError, mtWarning or mtLog
	messageId	unique message identification number
	pMessage	message string

---

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

• bsapi.h

---