OperationCompleteEvent

OperationCompleteEvent Class

Many asynchronous APIs will trigger an OperationCompleteEvent when done.

Syntax

public class OperationCompleteEvent : EventData

Remarks

Requirements

Namespace: Sansar.Script
Assembly: Sansar.Script (in Sansar.Script.dll)
Assembly Versions: 1.0.0.0

Members

See Also: Inherited members from EventData.

Public Constructors

 
Default constructor

Public Properties

[read-only]
 
Exception Exception . If an operation threw an exception Success will be false and the exception will be stored here.
[read-only]
 
Message string . If Success is false, Message may contain more information about the failure.
[read-only]
 
Success bool . Whether or not the operation completed successfully.

Public Methods

override
ToString () : string
Generates a string representation of the EventData. (Inherited from EventData.)

Member Details

OperationCompleteEvent Constructor

Default constructor

Syntax

public OperationCompleteEvent ()

Remarks

 

Requirements

Namespace: Sansar.Script
Assembly: Sansar.Script (in Sansar.Script.dll)
Assembly Versions: 1.0.0.0

Exception Property

If an operation threw an exception Success will be false and the exception will be stored here.

Syntax

public Exception Exception { get; }

Value

Documentation for this section has not yet been entered.

Remarks

 

Requirements

Namespace: Sansar.Script
Assembly: Sansar.Script (in Sansar.Script.dll)
Assembly Versions: 1.0.0.0

Message Property

If Success is false, Message may contain more information about the failure.

Syntax

public string Message { get; }

Value

Information about the failure.

Remarks

 

Requirements

Namespace: Sansar.Script
Assembly: Sansar.Script (in Sansar.Script.dll)
Assembly Versions: 1.0.0.0

Success Property

Whether or not the operation completed successfully.

Syntax

public bool Success { get; }

Value

true if the operation succeeded.

Remarks

 

Requirements

Namespace: Sansar.Script
Assembly: Sansar.Script (in Sansar.Script.dll)
Assembly Versions: 1.0.0.0


Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Article is closed for comments.