GetUtilByTimePeriod Method

• Visual Basic
• C#

'Declaration
 
Public Function GetUtilByTimePeriod( _
   ByVal utilTimeFilterType As UtilTimeFilterType, _
   ByVal utilStatusFilter As UtilStatusFilter, _
   ByVal LastNEvents As Nullable(Of Integer), _
   ByVal LastNHours As Nullable(Of Integer), _
   ByVal utilFilterUnAck As UtilFilterUnAck, _
   ByVal filterMinDuration As Integer, _
   ByVal filterTimeUnits As Nullable(Of FilterTimeUnit), _
   ByVal filterStartOffset As Nullable(Of Integer), _
   ByVal filterEndOffset As Nullable(Of Integer) _
) As DataSet

public DataSet GetUtilByTimePeriod( 
   UtilTimeFilterType utilTimeFilterType,
   UtilStatusFilter utilStatusFilter,
   Nullable<int> LastNEvents,
   Nullable<int> LastNHours,
   UtilFilterUnAck utilFilterUnAck,
   int filterMinDuration,
   Nullable<FilterTimeUnit> filterTimeUnits,
   Nullable<int> filterStartOffset,
   Nullable<int> filterEndOffset
)

Parameters

utilTimeFilterType

Required. Holds a UtilTimeFilterType enumeration value for specifying what time-based filtering, if any, is to be performed on the retrieved data.

utilStatusFilter

Required. Holds a UtilStatusFilter enumeration value for specifying what utilization status-based filtering, if any, is to be performed on the retrieved data.

LastNEvents

Optional. Holds an integer that determines how many events will be included in the control when the data is displayed. Used if the UtilTimeFilterType is LastNEvents.

LastNHours

Optional. Holds an integer that determines how many hours will be included in the control when the data is displayed. Used if the UtilTimeFilter is LastNHours.

utilFilterUnAck

Required. Holds the UtilFilterUnAck enumeration value, which specifies whether unacknowledged events, acknowledged events, or both should be shown.

filterMinDuration

Required. Holds an integer value that specifies the amount of time that had to be spent in the event in order to consider the event.

filterTimeUnits

Optional. Holds a FilterTimeUnit enumeration value that specifies the time unit for a custom filter, if utilTimeFilterType is Custom.

filterStartOffset

Optional. Holds an integer that specifies the start of the filter period relative to current period, if utilTimeFilterType is Custom.

filterEndOffset

Optional. Holds an integer that specifies the end of the filter period relative to current period, if utilTimeFilterType is Custom.

Return Value