dss::classic::IError Class Reference

Inheritance diagram for dss::classic::IError:

Collaboration diagram for dss::classic::IError:

Public Member Functions
	IError (dss::APIUtil *util)
string	Description ()
	Description of error for last operation.
int32_t	Number ()
	Error Number (returns current value and then resets to zero)
bool	EarlyAbort ()
	EarlyAbort controls whether all errors halts the DSS script processing (Compile/Redirect), defaults to True. More...
IError &	EarlyAbort (bool value)
bool	ExtendedErrors ()
	Controls whether the extended error mechanism is used. More...
IError &	ExtendedErrors (bool value)
Public Member Functions inherited from dss::ContextState
	ContextState (APIUtil *util)

Additional Inherited Members
Public Attributes inherited from dss::ContextState
void *	ctx
	Pointer to the DSSContext for easy access.
APIUtil *	api_util
	API utility functions.

Member Function Documentation

EarlyAbort()

bool dss::classic::IError::EarlyAbort ( )

inline

EarlyAbort controls whether all errors halts the DSS script processing (Compile/Redirect), defaults to True.

(API Extension)

ExtendedErrors()

bool dss::classic::IError::ExtendedErrors ( )

inline

Controls whether the extended error mechanism is used.

Defaults to True.

Extended errors are errors derived from checks across the API to ensure a valid state. Although many of these checks are already present in the original/official COM interface, the checks do not produce any error message. An error value can be returned by a function but this value can, for many of the functions, be a valid value. As such, the user has no means to detect an invalid API call.

Extended errors use the Error interface to provide a more clear message and should help users, especially new users, to find usage issues earlier.

At Python level, an exception is raised when an error is detected through the Error interface.

The current default state is ON. For compatibility, the user can turn it off to restore the previous behavior.

(API Extension)

---

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

• include/dss_classic.hpp