Click or drag to resize

Error Class

[This is preliminary documentation and is subject to change.]

[Missing <summary> documentation for "T:dss_sharp.Error"]

Inheritance Hierarchy

Namespace:  dss_sharp
Assembly:  dss_sharp (in dss_sharp.dll) Version: 1.0.0
public class Error : ContextState

The Error type exposes the following members.

Public methodError
Initializes a new instance of the Error class
Public propertyDescription
Description of error for last operation
Public propertyEarlyAbort
EarlyAbort controls whether all errors halts the DSS script processing (Compile/Redirect), defaults to True. (API Extension)
Public propertyExtendedErrors
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)
Public propertyNumber
Error Number (returns current value and then resets to zero)
Protected methodCheckForError (Inherited from ContextState.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetContextHandle
Returns the low-level handle of the current OpenDSS/DSS-CAPI instance.
(Inherited from ContextState.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodToString (Inherited from Object.)
Protected fieldapiutil (Inherited from ContextState.)
Protected fieldctx (Inherited from ContextState.)
See Also