IUpdateServer.GetUpdateStatus Method (UpdateScope, Boolean)

 

Applies To: Windows Server Update Services

Gets high-level status information summarizing the state of updates on this server.

Namespace:   Microsoft.UpdateServices.Administration
Assembly:  Microsoft.UpdateServices.Administration (in Microsoft.UpdateServices.Administration.dll)

Syntax

UpdateServerStatus GetUpdateStatus(
    UpdateScope updatesToInclude,
    bool includeDownstreamComputers
)

UpdateServerStatus^ GetUpdateStatus(
    UpdateScope^ updatesToInclude,
    bool includeDownstreamComputers
)

abstract GetUpdateStatus : 
        updatesToInclude:UpdateScope *
        includeDownstreamComputers:bool -> UpdateServerStatus

Function GetUpdateStatus (
    updatesToInclude As UpdateScope,
    includeDownstreamComputers As Boolean
) As UpdateServerStatus

Parameters

• updatesToInclude
  Type: Microsoft.UpdateServices.Administration.UpdateScope

  An UpdateScope that specifies the set of updates to include in the summary.

• includeDownstreamComputers
  Type: System.Boolean

  If true, include computers that synchronize from downstream servers when determining the UpdatesWithClientErrorsCount, UpdatesNeededByComputersCount, and UpdatesUpToDateCount. If false, do not include computers that synchronize from downstream servers.

Return Value

Type: Microsoft.UpdateServices.Administration.UpdateServerStatus

An UpdateServerStatus object summarizing the state of the specified updates on this server.

Remarks

This method updates only the UpdateCount, DeclinedUpdateCount, UpdatesWithClientErrorsCount, UpdatesNeededByComputersCount, and UpdatesUpToDateCount properties. All other properties will be 0 or empty.

See Also

IUpdateServer Interface
Microsoft.UpdateServices.Administration Namespace

Return to top