Views
Studio Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
IlvStError Class Reference

Error class. More...

#include <ivstudio/error.h>

Public Member Functions

 IlvStError (const char *message=0, IlvStErrorType type=IlvStInformation, IlBoolean popup=IlFalse)
 Initializes an instance of IlvStError. More...
 
const char * getMessage () const
 Returns the message. More...
 
IlvStErrorType getType () const
 Returns the message type. More...
 
IlBoolean isPopup () const
 Returns IlTrue if the message must be displayed. More...
 

Detailed Description

Error class.

Library: ivstudio

This class is used to define an error message.

See also
IlvStudio.

Constructor & Destructor Documentation

◆ IlvStError()

IlvStError::IlvStError ( const char *  message = 0,
IlvStErrorType  type = IlvStInformation,
IlBoolean  popup = IlFalse 
)

Initializes an instance of IlvStError.

Parameters
messageThe message.
typeThe message type.
popupIf IlTrue the message will be displayed, otherwise it will be displayed in an error window.

Member Function Documentation

◆ getMessage()

const char* IlvStError::getMessage ( ) const

Returns the message.

Returns
The message.

◆ getType()

IlvStErrorType IlvStError::getType ( ) const

Returns the message type.

Returns
The message type.

◆ isPopup()

IlBoolean IlvStError::isPopup ( ) const

Returns IlTrue if the message must be displayed.

Returns
IlTrue if the message must be displayed, otherwise returns IlFalse.