Ensenso::NxLibException¶
-
class
Ensenso
::
NxLibException
: public Exception¶ This class encapsulates NxLib API errors. All overloaded functions of Ensenso::NxLibItem and Ensenso::NxLibCommand not taking a return code pointer will throw and NxLibException when the API return code indicates an error.
Public Functions
-
NxLibException
(::NxLibException const &e)¶ Creates a new Ensenso::NxLibException from the native NxLibException.
- Parameters
e
: native NxLibException Object (C++)
-
~NxLibException
()¶ Destructor. Calls the Finalizer.
-
int
GetErrorCode
()¶ Retrieves the API return code that has caused this exception.
- Return
The error code because of which the exception object was thrown.
-
const String
GetErrorText
()¶ Retrieves the error text, corresponding to the API return code that has caused this exception. This is the error text return by Ensenso::sealed::TranslateReturnCode(int)
- Return
The text corresponding to the error code.
-
const String
GetItemPath
()¶ Retrieves the path of the item that was attempted to access when the exception was thrown.
- Return
The path of the item that has caused the exception.
-