IErrorContext Class Reference

Interface for error handling. More...

#include <ierrorcontext.h>

Inheritance diagram for IErrorContext:
Inheritance graph
[legend]

Public Member Functions

virtual void disableErrorUI (bool state)=0
 Tells the plug-in to not show any UI elements on errors.
virtual tresult errorMessageShown ()=0
 If an error happens and disableErrorUI was not set this should return kResultTrue if the plug-in already showed a message to the user what happened.
virtual tresult getErrorMessage (IString *message)=0
 Fill message with error string.

Static Public Attributes

static const FUID iid

Detailed Description

Interface for error handling.

[plug imp]
[released: Sequel 2]


Member Function Documentation

virtual void disableErrorUI ( bool  state  )  [pure virtual]

Tells the plug-in to not show any UI elements on errors.

virtual tresult errorMessageShown (  )  [pure virtual]

If an error happens and disableErrorUI was not set this should return kResultTrue if the plug-in already showed a message to the user what happened.

virtual tresult getErrorMessage ( IString message  )  [pure virtual]

Fill message with error string.

The host may show this to the user.


Field Documentation

const FUID iid [static]

Reimplemented from FUnknown.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines
Empty

Copyright ©2013 Steinberg Media Technologies GmbH. All Rights Reserved.