DataAsyncCommandEvents Class

Article
10/02/2013

Represents a set of delegates that are called by methods on the DataAsyncCommand class to notify clients of command progress.

Inheritance Hierarchy

System.Object
Microsoft.VisualStudio.Data.DataAsyncCommandEvents

Namespace: Microsoft.VisualStudio.Data
Assembly: Microsoft.VisualStudio.Data (in Microsoft.VisualStudio.Data.dll)

Syntax

'Declaration
Public Class DataAsyncCommandEvents

public class DataAsyncCommandEvents

public ref class DataAsyncCommandEvents

type DataAsyncCommandEvents =  class end

public class DataAsyncCommandEvents

The DataAsyncCommandEvents type exposes the following members.

Constructors

	Name	Description
	DataAsyncCommandEvents()	Instantiates a new instance of the DataAsyncCommandEvents class.
	DataAsyncCommandEvents(DataAsyncCommandStartEventHandler, DataAsyncCommandFailureEventHandler, DataAsyncCommandCancelEventHandler, DataAsyncCommandEndEventHandler)	Initializes a new instance of the DataAsyncCommandEvents class with the specified delegates.
	DataAsyncCommandEvents(DataAsyncCommandStartEventHandler, DataAsyncCommandFailureEventHandler, DataAsyncCommandFetchEventHandler, DataAsyncCommandFetchEventHandler, DataAsyncCommandCancelEventHandler, DataAsyncCommandEndEventHandler)	Initializes a new instance of the DataAsyncCommandEvents class with the specified delegates.

Top

Properties

	Name	Description
	CommandCancel	Retrieves or sets the delegate that is called when an asynchronous command is canceled.
	CommandEnd	Retrieves or sets the delegate that is called when an asynchronous command has ended.
	CommandFailure	Retrieves or sets the delegate that is called when an asynchronous command has a failure.
	CommandNextResult	Gets or sets the delegate that is called when an asynchronous command has one or more result sets available.
	CommandRead	Retrieves or sets the delegate that is called when an asynchronous command has one or more blocks of data available to read in a result set.
	CommandStart	Retrieves or sets the delegate that is called when an asynchronous command starts.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

When a call is made to one of the Async_ methods on the DataAsyncCommand class, an instance of this class is passed in to allow the asynchronous method to notify the caller of command progress.

The caller can register zero or more of their own methods with the asynchronous method by creating an instance of this class and setting values for the delegate properties to point at their methods.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via