uaPLUS Reference
GetFilter Method
See Also  Send Feedback
NSPlugin Namespace > EventSubscription Class : GetFilter Method

_eventType
A bit map with EventType enumerator flags specifying which event types are of allowed through the CurrentEventFilter.
numCategories
Length of the event category array returned.
eventCategories
Array of event categories for the CurrentEventFilter.
lowSeverity
Lowest severity allowed through CurrentEventFilter. If the server does not support filtering on severity, the returned value will be 1.
highSeverity
Highest severity allowed through CurrentEventFilter. If the server does not support filtering on severity, the returned value will be 1000.
numAreas
Length of the area list array returned.
areaList
List of process areas for the CurrentEventFilter.
numSources
Length of the event source list returned.
sourceList
List of sources for the CurrentEventFilter.

Glossary Item Box

Returns the filter currently in use for event subscriptions.
If a server does not support one or more of the filter criteria requested in SetFilter, it returns empty arrays for lists, and values which indicate no filtering is taking place for non-list items. In these cases, it does not return any filters which may have been requested in SetFilter, but which were ignored.

Syntax

Visual Basic (Declaration) 
Public Function GetFilter( _
   ByRef _eventType As Integer, _
   ByRef numCategories As Integer, _
   ByRef eventCategories As Integer(), _
   ByRef lowSeverity As Integer, _
   ByRef highSeverity As Integer, _
   ByRef numAreas As Integer, _
   ByRef areaList As String(), _
   ByRef numSources As Integer, _
   ByRef sourceList As String() _
) As Integer
C# 
public int GetFilter( 
   out int _eventType,
   out int numCategories,
   out int[] eventCategories,
   out int lowSeverity,
   out int highSeverity,
   out int numAreas,
   out string[] areaList,
   out int numSources,
   out string[] sourceList
)

Parameters

_eventType
A bit map with EventType enumerator flags specifying which event types are of allowed through the CurrentEventFilter.
numCategories
Length of the event category array returned.
eventCategories
Array of event categories for the CurrentEventFilter.
lowSeverity
Lowest severity allowed through CurrentEventFilter. If the server does not support filtering on severity, the returned value will be 1.
highSeverity
Highest severity allowed through CurrentEventFilter. If the server does not support filtering on severity, the returned value will be 1000.
numAreas
Length of the area list array returned.
areaList
List of process areas for the CurrentEventFilter.
numSources
Length of the event source list returned.
sourceList
List of sources for the CurrentEventFilter.

Requirements

Target Platforms: Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows 7, Windows Server 2008 family

See Also

© 2010-2018 Copyright Advosol Inc. All Rights Reserved.