CheckForUpdateCompletedEventArgs Class
Represents detailed update information obtained through a call to CheckForUpdateAsync.
System.EventArgs
System.ComponentModel.AsyncCompletedEventArgs
System.Deployment.Application.CheckForUpdateCompletedEventArgs
Assembly: System.Deployment (in System.Deployment.dll)
The CheckForUpdateCompletedEventArgs type exposes the following members.
| Name | Description | |
|---|---|---|
.gif?cs-save-lang=1&cs-lang=fsharp "Public property") | AvailableVersion | Gets the version number of the latest uninstalled version. |
| Cancelled | Gets a value indicating whether an asynchronous operation has been canceled. (Inherited from AsyncCompletedEventArgs.) |
| Error | Gets a value indicating which error occurred during an asynchronous operation. (Inherited from AsyncCompletedEventArgs.) |
| IsUpdateRequired | Gets a value indicating whether the update must be installed. |
| MinimumRequiredVersion | Gets the minimum version that the user must have installed on the computer. |
| UpdateAvailable | Gets whether an uninstalled update is available. |
| UpdateSizeBytes | Gets the size of the available update. |
| UserState | Gets the unique identifier for the asynchronous task. (Inherited from AsyncCompletedEventArgs.) |
| Name | Description | |
|---|---|---|
.gif?cs-save-lang=1&cs-lang=fsharp "Public method") | Equals(Object) | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
.gif?cs-save-lang=1&cs-lang=fsharp "Protected method") | 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 a hash function for a particular type. (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.) |
| RaiseExceptionIfNecessary | Raises a user-supplied exception if an asynchronous operation failed. (Inherited from AsyncCompletedEventArgs.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
With CheckForUpdateCompletedEventArgs, you can decide whether to upgrade your ClickOnce application based on information about the newest version. UpdateAvailable will return a Boolean value indicating whether there is a new update at all. The AvailableVersion property provides the version number of the new version, while MinimumRequiredVersion provides the earliest version that the user should have installed on the computer. IsUpdateRequired expresses whether the latest available update is required of the user. Finally, UpdateSizeBytes expresses the total size of the update.
The following code example uses UpdateAvailable to determine if there is a new application update, and IsUpdateRequired to determine whether to ask the user to install the update.
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
