EKM Client API

- Main Page
- Namespaces
- Classes

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

Public Member Functions
com::ansys::ingress::client::api::TransferEventError Class Reference

TransferEventError contains information about a failed transfer. More...

List of all members.

## Public Member Functions

| TransferEventError (ConnectorEventError error)
| Creates a new instance of TransferEventError.
string | GetException ()
| Gets the reason for the error.
string[] | GetFailures ()
| Gets the files and folders that failed to be transferred.
string | GetMessage ()
| Gets a message describing the error.
string | GetRootCause ()
| Gets the root cause of the error if one exists.
string | GetStackTrace ()
| Gets a stack trace showing the location of the error.

## Detailed Description

TransferEventError contains information about a failed transfer.

## Constructor & Destructor Documentation

com::ansys::ingress::client::api::TransferEventError::TransferEventError | ( | ConnectorEventError | error | ) | `[inline]`

Creates a new instance of TransferEventError.

Parameters:

  error | low level error information

## Member Function Documentation

string com::ansys::ingress::client::api::TransferEventError::GetException | ( |  | ) | `[inline]`

Gets the reason for the error.

Returns:
  Returns the full qualified class name of the exception that was thrown when the error occurred.

string [] com::ansys::ingress::client::api::TransferEventError::GetFailures | ( |  | ) | `[inline]`

Gets the files and folders that failed to be transferred.

Returns:
  Returns an array containing the files and folders that were not transferred.

string com::ansys::ingress::client::api::TransferEventError::GetMessage | ( |  | ) | `[inline]`

Gets a message describing the error.

Returns:
  Returns the message.

string com::ansys::ingress::client::api::TransferEventError::GetRootCause | ( |  | ) | `[inline]`

Gets the root cause of the error if one exists.

Returns:
  Returns the full qualified class name of the exception that is the root cause of the exception or null if there is no root cause other than the original exception.

string com::ansys::ingress::client::api::TransferEventError::GetStackTrace | ( |  | ) | `[inline]`

Gets a stack trace showing the location of the error.

Returns:
  Returns the stack trace.

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

- TransferMonitor.cs

All Classes Namespaces Functions Variables Enumerations Properties