EKM Client API

- Main Page
- Namespaces
- Classes

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | Properties
com::ansys::ingress::client::api::EkmException Class Reference

EkmException is the base class for exceptions thrown by the EKM Connector User API. More...

Inheritance diagram for com::ansys::ingress::client::api::EkmException:

List of all members.

## Public Member Functions

| EkmException (Exception rootCause)
| Creates a new EkmException instance.
| EkmException (string message)
| Creates a new EkmException instance.

## Properties

string | JavaClass`[get, set]`
| The class of the Java excetpion.
bool | NoLicense`[get, set]`
| If the error is due to no license available.
string | RootClass`[get, set]`
| Root cause class of the exception.
string | RootMessage`[get, set]`
| Root cause message.
bool | ServerError`[get, set]`
| Error message from the server.
string | ServerTrace`[get, set]`
| Server stack trace.
bool | TooManyConnections`[get, set]`
| If the error is due to too many connections.

## Detailed Description

EkmException is the base class for exceptions thrown by the EKM Connector User API.

## Constructor & Destructor Documentation

com::ansys::ingress::client::api::EkmException::EkmException | ( | Exception | rootCause | ) | `[inline]`

Creates a new EkmException instance.

Parameters:

  rootCause | the root cause of the exception

com::ansys::ingress::client::api::EkmException::EkmException | ( | string | message | ) | `[inline]`

Creates a new EkmException instance.

Parameters:

  message | A message describing the exception

## Property Documentation

string com::ansys::ingress::client::api::EkmException::JavaClass`[get, set]`

The class of the Java excetpion.

bool com::ansys::ingress::client::api::EkmException::NoLicense`[get, set]`

If the error is due to no license available.

string com::ansys::ingress::client::api::EkmException::RootClass`[get, set]`

Root cause class of the exception.

string com::ansys::ingress::client::api::EkmException::RootMessage`[get, set]`

Root cause message.

bool com::ansys::ingress::client::api::EkmException::ServerError`[get, set]`

Error message from the server.

string com::ansys::ingress::client::api::EkmException::ServerTrace`[get, set]`

Server stack trace.

bool com::ansys::ingress::client::api::EkmException::TooManyConnections`[get, set]`

If the error is due to too many connections.

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

- Exceptions.cs

All Classes Namespaces Functions Variables Enumerations Properties