Interface Technology Basics: IErrorContext Class Reference
Author: Steinberg

Interface Technology Basics VST 3.8 SDK for developing VST plug-in

Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
IErrorContext Class Referenceabstract

Interface for error handling. More...

`#include <ierrorcontext.h>`

Inheritance diagram for IErrorContext:

## 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.
Public Member Functions inherited from FUnknown
virtual tresult | queryInterface (const TUID _iid, void **obj)=0
| Query for a pointer to the specified interface.
virtual uint32 | addRef ()=0
| Adds a reference and returns the new reference count.
virtual uint32 | release ()=0
| Releases a reference and returns the new reference count.

## Static Public Attributes
static const FUID | iid
Static Public Attributes inherited from FUnknown
static const FUID | iid

## Detailed Description

Interface for error handling.

- [plug imp]
- [released: Sequel 2]

## Member Function Documentation

## ◆ disableErrorUI()

virtual void disableErrorUI | ( | bool | state | ) |
| pure virtual

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

## ◆ errorMessageShown()

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.

## ◆ getErrorMessage()

virtual tresult getErrorMessage | ( | IString * | message | ) |
| pure virtual

Fill message with error string.

The host may show this to the user.

## Member Data Documentation

## ◆ iid

const FUID iid
| static

Empty

Copyright © Steinberg Media Technologies GmbH. All Rights Reserved. This documentation is under this license.