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

eventCategory
The specific event category for which the list of attributes applies. These are returned from the EventServer.QueryEventCategories method.
attributeIDs
The list IDs of the attributes to return with event notifications for the event type and event category specified. These are returned from the EventServer.QueryEventAttributes method.

Glossary Item Box

For each Event Category, SelectReturnedAttributes sets the attributes to be returned with event notifications in the IOPCEventSink::OnEvent callback. This method can be called multiple times in order to specify the attributes to return for each unique event type and event category pair. For a given event type and event category pair, the attributes returned can be “cleared” by setting the dwCount parameter to zero. If this is called multiple times for the same event type and event category pair, then the latest call will be in effect.

Syntax

Visual Basic (Declaration) 
Public Function SelectReturnedAttributes( _
   ByVal eventCategory As Integer, _
   ByVal attributeIDs() As Integer _
) As Integer
C# 
public int SelectReturnedAttributes( 
   int eventCategory,
   int[] attributeIDs
)

Parameters

eventCategory
The specific event category for which the list of attributes applies. These are returned from the EventServer.QueryEventCategories method.
attributeIDs
The list IDs of the attributes to return with event notifications for the event type and event category specified. These are returned from the EventServer.QueryEventAttributes method.

Return Value

E_FAIL, E_INVALIDARG, S_OK Note that one or more of the passed IDs may not be valid for the particular Category for a variety of reasons including dynamic changes in the Server configuration. There is currently no indication to the Client that this has happened other than that the objects returned for these items in the EventData will be null. Note that the EventData will still contain an array of Attributes even if some of them are NULL.

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.