uaPLUS Reference
QueryConditionNames Method
See Also  Send Feedback
NSPlugin Namespace > AlarmEventServer Class : QueryConditionNames Method

eventCategory
An event category code, as returned by the QueryEventCategories method. Only the names of conditions within this event category are returned.
count
The number of condition names being returned.
conditionNames
Array of strings containing the condition names for the specified event category.

Glossary Item Box

The QueryConditionNames method gives clients a means of finding out the specific condition names which the event server supports for the specified event category. This method would typically be invoked prior to specifying an event filter. Condition names are server specific.
The number of condition names returned will vary depending on the sophistication of the server, but is expected to be less than 30 for most servers, making this interface more appropriate than a custom enumerator. It is expected that the results of the Query will be fairly 'stable' in most situations. However, the Server is in fact allowed to change the available selection at any time. Therefore, a Client should do (or at least allow as an option) a fresh Query every time a selection is to be presented to the end user.

Syntax

Visual Basic (Declaration) 
Public Function QueryConditionNames( _
   ByVal eventCategory As Integer, _
   ByRef count As Integer, _
   ByRef conditionNames As String() _
) As Integer
C# 
public int QueryConditionNames( 
   int eventCategory,
   out int count,
   out string[] conditionNames
)

Parameters

eventCategory
An event category code, as returned by the QueryEventCategories method. Only the names of conditions within this event category are returned.
count
The number of condition names being returned.
conditionNames
Array of strings containing the condition names for the specified event category.

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.