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 an NxLibException when the API return code indicates an error.
Public Functions
-
inline NxLibException(::NxLibException const &e)¶
Creates a new Ensenso::NxLibException from the native NxLibException.
- Parameters
e – native NxLibException Object (C++)
-
inline ~NxLibException()¶
Destructor. Calls the Finalizer.
-
inline int GetErrorCode()¶
Retrieves the API return code that has caused this exception.
- Returns
The error code because of which the exception object was thrown.
-
inline 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)
- Returns
The text corresponding to the error code.
-
inline const String GetItemPath()¶
Retrieves the path of the item that was attempted to access when the exception was thrown.
- Returns
The path of the item that has caused the exception.
-
inline NxLibException(::NxLibException const &e)¶