Windows Update Agent (WUA) API Reference

 10/18/2017
 2 minutes to read

The Windows Update Agent (WUA) API 4.0 Type Library defines the following data types:

 Enumerations
 Interfaces
 Structures
Enumerations
 10/18/2017
 2 minutes to read

Windows Update Agent (WUA) uses the enumerations that are listed in the following table to represent the
status of operations.

Enumerations
Enumeration Description
Defines the possible ways in which the service registration can
AddServiceFlag
be processed.
Defines the logic that is used to determine whether Automatic
AutoDownloadMode Updates will automatically download an update once it is
determined to be applicable for the computer.
Defines the possible ways in which elevated users are notified
AutomaticUpdatesNotificationLevel
about Automatic Updates events.
Defines the possible ways to set the
IAutomaticUpdatesSettings::NotificationLevel property or
AutomaticUpdatesPermissionType the or the
IAutomaticUpdatesSettings2::IncludeRecommendedUpdate
s property.
AutomaticUpdatesScheduledInstallationDa Defines the days of the week when Automatic Updates installs
y or uninstalls updates.
AutomaticUpdatesUserType Describes the type of user.
Defines the logic used to determine whether a particular update
AutoSelectionMode will be automatically selected when the user views the available
updates in the Windows Update user interface.
DeploymentAction Defines the action for which an update is explicitly deployed.
Defines the progress of the download of a current update that is
returned by the
DownloadPhase
IDownloadProgress::CurrentUpdateDownloadPhase
property.
DownloadPriority Defines the possible priorities for a download operation.
Defines the possible levels of impact that can be caused by
InstallationImpact
installing or uninstalling an update.
InstallationRebootBehavior Defines the possible restart behaviors for an update.
Defines the possible results of a download, install, uninstall, or
OperationResultCode
verification operation on an update.
Specifies the variety of updates that should be returned by the
search: per-machine updates, per-user updates, or both. Per-user
SearchScope
updates are updates designed to affect only a single user’s
environment. For more information, see IUpdate4::PerUser.
Defines the update services that Windows Update can operate
ServerSelection
against. .
Defines the type of tokens that can be used for authenticating
UpdateEndpointAuthTokenType
with an endpoint.
UpdateEndpointType Defines the type of endpoints that can be used to connect to a

Enumeration
UpdateExceptionContext
UpdateLockdownOption
UpdateOperation
UpdateServiceOption
UpdateServiceRegistrationState
UpdateType
Enumerations
Description
service.
Defines the context in which an IUpdateException object can
be provided.
Defines the functionality that the Windows Update Agent
(WUA) object can access from Windows Update.
Defines the operations that can be attempted on an update.
Defines the options to remove the service registration for a scan
package service.
Defines the possible states for an update service.
Indicates whether an update is a software update or a driver
update.
Interfaces
 10/18/2017
 4 minutes to read
The following table identifies the interfaces that are used to access Windows Update Agent (WUA).
Interface
IAutomaticUpdates
IAutomaticUpdates2
IAutomaticUpdatesResults
IAutomaticUpdatesSettings
IAutomaticUpdatesSettings2
IAutomaticUpdatesSettings3
ICategory
ICategoryCollection
IDownloadCompletedCallback
IDownloadCompletedCallbackArgs
IDownloadJob
IDownloadProgress
IDownloadProgressChangedCallback
IDownloadProgressChangedCallbackArgs
IDownloadResult
IImageInformation
IInstallationAgent
IInstallationBehavior
IInstallationCompletedCallback
IInstallationCompletedCallbackArgs
IInstallationJob
IInstallationProgress
Interfaces
Description
Contains the functionality of Automatic Updates.
Contains the functionality of Automatic Updates.
Contains the read-only properties that describe Automatic
Updates.
Contains the settings that are available in Automatic Updates.
Contains the settings that are available in Automatic Updates.
Contains the settings that are available in Automatic Updates.
Represents the category for an update.
Represents an ordered read-only list of ICategory interfaces.
Contains the IDownloadCompletedCallback::Invoke method
that handles the notification that indicates that an asynchronous
download operation is complete.
Contains information about the completion of an update
download. This interface is reserved for future use and has no
properties or methods.
Contains the properties and methods that are available to a
download operation.
Represents the progress of an asynchronous download
operation.
Contains the method that handles the notification about the
progress of an asynchronous download operation.
Contains information about the change of progress of an
asynchronous download operation.
Represents the result of a download operation.
Contains information about a localized image that is associated
with an update or a category.
Records the result for an update.
Represents the installation and uninstallation options of an
update.
References the method that handles the notification about the
completion of an asynchronous installation or uninstallation.
Contains information about the completion of an installation.
This interface is reserved for future use and has no properties or
methods.
Contains properties and methods that are available to an
installation or uninstallation operation.
Represents the progress of an asynchronous installation or
uninstallation.
 Interfaces
Interface Description
Handles the notification about the on-going progress of an
IInstallationProgressChangedCallback
asynchronous installation or uninstallation.
Contains info about the change in the progress of an
IInstallationProgressChangedCallbackArgs asynchronous installation or uninstallation at the time the
callback was made.
IInstallationResult Represents the result of an installation or uninstallation.
Encapsulates the exception that is thrown when an invalid
IInvalidProductLicenseException
license is detected on a product.
Contains the method that handles the notification about the
ISearchCompletedCallback
completion of an asynchronous search operation.
Contains information about the completion of an asynchronous
ISearchCompletedCallbackArgs
search.
Contains the properties and methods that are available to a
ISearchJob
search operation.
ISearchResult Represents the result of a search.
IStringCollection Represents an ordered list of strings.
Contains information about a specified computer that is relevant
ISystemInformation
to the update service.
Contains the properties and methods that are available to an
IUpdate
update.
Contains the properties and methods that are available to an
IUpdate2
update.
Contains the properties and methods that are available to an
IUpdate3
update.
Contains the properties and methods that are available to an
IUpdate4
update.
Contains the properties and methods that are available to an
IUpdate5
update.
IUpdateCollection Represents an ordered list of updates.
IUpdateDownloadContent Represents the download content of an update.
IUpdateDownloadContent2 Represents the download content of an update.
IUpdateDownloadContentCollection Represents a collection of download contents.
IUpdateDownloader Downloads updates from a server.
Contains the properties that indicate the status of a download
IUpdateDownloadResult
operation for an update.
Contains the methods used to negotiate which type of token is
IUpdateEndpointAuthProvider
used for authenticating the endpoint of a service.
Provides the methods that WUA can use to gather info about the
IUpdateEndpointAuthToken
endpoint token.
Contains the method used to get an endpoint that is used to
IUpdateEndpointProvider
connect to a service.
Represents info about the aspects of search results returned in
IUpdateException
the ISearchResult object that were incomplete.
Represents an ordered read-only list of IUpdateException
IUpdateExceptionCollection
interfaces.
IUpdateHistoryEntry Represents an event about an update.
 Interfaces
Interface Description
IUpdateHistoryEntry2 Represents an event about an update.
Represents an ordered read-only list of IUpdateHistoryEntry
IUpdateHistoryEntryCollection
interfaces.
IUpdateIdentity Represents the unique identifier of an update.
Contains the properties and methods that are available to the
IUpdateInstallationResult
status of an installation or uninstallation of an update.
IUpdateInstaller Installs or uninstalls updates from or onto a computer.
IUpdateInstaller2 Installs or uninstalls updates from or onto a computer.
IUpdateInstaller4 Installs or uninstalls updates from or onto a computer.
Contains a method that restricts access to some methods and
IUpdateLockdown
properties of the object that implements the method.
IUpdateSearcher Searches for updates on a server.
IUpdateSearcher2 Searches for updates on a server.
IUpdateSearcher3 Searches for updates on a server.
Contains information about a service that is registered with
IUpdateService
WUA or Automatic Updates.
Contains information about a service that is registered with
IUpdateService2
WUA or Automatic Updates.
IUpdateServiceCollection Represents a list of IUpdateService interfaces.
Adds or removes the registration of the update service with
IUpdateServiceManager
WUA or Automatic Updates.
Adds or removes the registration of the update service with
IUpdateServiceManager2
WUA or Automatic Updates.
IUpdateServiceRegistration Contains info about the registration state of a service.
Represents a session in which the caller can perform operations
IUpdateSession
that involve updates.
Represents a session in which the caller can perform operations
IUpdateSession2
that involve updates.
Represents a session in which the caller can perform operations
IUpdateSession3
that involve updates.
IWebProxy Contains HTTP proxy settings.
Contains the properties and methods that are available only
IWindowsDriverUpdate
from a Windows driver update.
Contains the properties and methods that are available only
IWindowsDriverUpdate2
from a Windows driver update.
Contains the properties and methods that are available only
IWindowsDriverUpdate3
from a Windows driver update.
Contains the properties and methods that are available only
IWindowsDriverUpdate4
from a Windows driver update.
Contains the properties and methods that are available only
IWindowsDriverUpdate5
from a Windows driver update.
Contains the properties that are available only from a Windows
IWindowsDriverUpdateEntry
driver update.
Contains the properties that are available only from a collection
IWindowsDriverUpdateEntryCollection
of Windows driver updates.
IWindowsUpdateAgentInfo Retrieves information about the version of WUA.
Structures
 10/18/2017
 2 minutes to read

Windows Update Agent (WUA) uses the structures that are listed in the following table to provide data.

Structures
Structure Description
UpdateEndpointProxySettings Defines the proxy settings used when requesting an endpoint token.