GetServerLoadInfo Method

In This Topic

Gets information about the current load on the server and/or its Agents.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<NotNullAttribute()>
Public Function GetServerLoadInfo( _
   ByVal includeMaster As Boolean, _
   ByVal includeAgents As Boolean, _
   ByVal agentOIDs() As OID _
) As ReadOnlyCollection(Of ServerLoadInfo)

[NotNull()]
public ReadOnlyCollection<ServerLoadInfo> GetServerLoadInfo( 
   bool includeMaster,
   bool includeAgents,
   OID[] agentOIDs
)

[NotNull()]
public:
ReadOnlyCollection<ServerLoadInfo^>^ GetServerLoadInfo( 
   bool includeMaster,
   bool includeAgents,
   array<OID^>^ agentOIDs
)

Parameters

includeMaster: Includes load information for the current server.
includeAgents: Includes load information for all or selected Remote Agents.
agentOIDs: List of the OIDs of the Agents to return load information for, or null for all Agents.

Return Value

The most recent load information.

Reference

Scheduler Class
Scheduler Members