EKM Client API

- Main Page
- Namespaces
- Classes

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

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

TransferEvent contains detailed information about a file transfer and is passed to objects that implement the TransferEventListener interface or extend the TransferEventAdapter class. More...

List of all members.

## Public Member Functions

| TransferEvent (ConnectorEvent eventObj)
| Creates a new instance of TransferEvent.
TransferEventError | GetError ()
| Gets error information.
int | GetProgress ()
| Gets the progress of the transfer.
TransferEventReason | GetReason ()
| Gets the reason for the event.
string | GetSource ()
| Gets the source of the event.
String | GetRemotePath ()
| Returns the remote path of a file that was downloaded from the server.
String | GetLocalPath ()
| Returns the local path of a file that was downloaded from the server.
DateTime | GetLastModified ()
| Returns the last modified date and time of a file downloaded from the server.

## Detailed Description

TransferEvent contains detailed information about a file transfer and is passed to objects that implement the TransferEventListener interface or extend the TransferEventAdapter class.

## Constructor & Destructor Documentation

com::ansys::ingress::client::api::TransferEvent::TransferEvent | ( | ConnectorEvent | eventObj | ) | `[inline]`

Creates a new instance of TransferEvent.

Parameters:

  eventObj | low level event data

## Member Function Documentation

TransferEventError com::ansys::ingress::client::api::TransferEvent::GetError | ( |  | ) | `[inline]`

Gets error information.

Returns:
  Returns error information about the event or null if no error occurred.

DateTime com::ansys::ingress::client::api::TransferEvent::GetLastModified | ( |  | ) | `[inline]`

Returns the last modified date and time of a file downloaded from the server.

Returns:
  Returns the date and time the file was last modified.

String com::ansys::ingress::client::api::TransferEvent::GetLocalPath | ( |  | ) | `[inline]`

Returns the local path of a file that was downloaded from the server.

Returns:
  Returns the path.

int com::ansys::ingress::client::api::TransferEvent::GetProgress | ( |  | ) | `[inline]`

Gets the progress of the transfer.

Returns:
  Returns a number from 0 to 100 indicating the progress of the event.

TransferEventReason com::ansys::ingress::client::api::TransferEvent::GetReason | ( |  | ) | `[inline]`

Gets the reason for the event.

Returns:
  Returns one of the values defined in the TransferEventReason enum.

String com::ansys::ingress::client::api::TransferEvent::GetRemotePath | ( |  | ) | `[inline]`

Returns the remote path of a file that was downloaded from the server.

Returns:
  Returns the path.

string com::ansys::ingress::client::api::TransferEvent::GetSource | ( |  | ) | `[inline]`

Gets the source of the event.

Returns:
  Returns the source.

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

- TransferMonitor.cs

All Classes Namespaces Functions Variables Enumerations Properties