| DSSCOMErrorResults Property |
[This is preliminary documentation and is subject to change.]
If enabled, in case of errors or empty arrays, the API returns arrays with values compatible with the
official OpenDSS COM interface.
For example, consider the function `Loads_Get_ZIPV`. If there is no active circuit or active load element:
- In the disabled state (COMErrorResults=False), the function will return "[]", an array with 0 elements.
- In the enabled state (COMErrorResults=True), the function will return "[0.0]" instead. This should
be compatible with the return value of the official COM interface.
Defaults to True/1 (enabled state) in the v0.12.x series. This will change to false in future series.
This can also be set through the environment variable DSS_CAPI_COM_DEFAULTS. Setting it to 0 disables
the legacy/COM behavior. The value can be toggled through the API at any time.
(API Extension)
Namespace:
dss_sharp
Assembly:
dss_sharp (in dss_sharp.dll) Version: 1.0.0
Syntax public bool COMErrorResults { get; set; }
Public Property COMErrorResults As Boolean
Get
Set
public:
property bool COMErrorResults {
bool get ();
void set (bool value);
}
member COMErrorResults : bool with get, set
function get_COMErrorResults();
function set_COMErrorResults(value);
Property Value
Type:
BooleanSee Also