OPC Labs EasyOPC “Classic” Components Library
EasyAEClient Object Members
Overview 
OpcLabs_EasyOpcClassicComponents ActiveX DLL : EasyAEClient Object
Public Methods
Public Method AcknowledgeConditionAcknowledges a condition in the Event Server. Uses server descriptor for specifying the OPC server. Pass in acknowledger ID and comment.

 

DISPID (Dispatch ID):

 

For more information, see AcknowledgeCondition in .NET Reference.

Public Method add_Disposed

 

DISPID (Dispatch ID):

 

For more information, see add_Disposed in .NET Reference.

Public Method BrowseAreasBrowses the specified area for child areas. Uses computer name and server class for specifying the OPC server. A parent area is passed in. No filtering.

 

DISPID (Dispatch ID):

 

For more information, see BrowseAreas in .NET Reference.

Public Method BrowseNodesBrowses the specified area (or root) in OPC server's process area space, and returns information about child nodes (areas or sources) found.

 

DISPID (Dispatch ID):

 

For more information, see BrowseNodes in .NET Reference.

Public Method BrowseServersBrowses the specified computer and returns information about OPC (Alarms and Events) servers found.

 

DISPID (Dispatch ID):

 

For more information, see BrowseServers in .NET Reference.

Public Method BrowseSourcesBrowses the specified area for child sources. Uses computer name and server class for specifying the OPC server. A parent area is passed in. No filtering.

 

DISPID (Dispatch ID):

 

For more information, see BrowseSources in .NET Reference.

Public Method ChangeEventSubscriptionChanges parameters of an event subscription. Specify new notification rate, subscription filter object, and an "active" flag.

 

DISPID (Dispatch ID):

 

For more information, see ChangeEventSubscription in .NET Reference.

Public Method CloneCreates a new object that is a copy of the current instance.

 

DISPID (Dispatch ID):

 

For more information, see Clone in .NET Reference.

Public Method Dispose

 

DISPID (Dispatch ID):

 

For more information, see Dispose in .NET Reference.

Public Method EqualsDetermines whether the specified object is equal to the current object.

 

DISPID (Dispatch ID):

 

For more information, see Equals in .NET Reference.

Public Method GetConditionStateReturns the current state information for the condition instance corresponding to the source and condition name, passing in a server descriptor. Also allows to retrieve specified event attributes using an array.

 

DISPID (Dispatch ID):

 

For more information, see GetConditionState in .NET Reference.

Public Method GetConditionStateListReturns the current state information for the condition instance corresponding to the source and condition name, passing in a server descriptor. Also allows to retrieve specified event attributes using a list.

 

DISPID (Dispatch ID):

 

For more information, see OpcLabs.EasyOpc.AlarmsAndEvents.ComTypes._EasyAEClient.GetConditionStateList in .NET Reference.

Public Method GetEventsSubscriptionArgumentsObtains parameters of specified events subscription.

 

DISPID (Dispatch ID):

 

For more information, see GetEventsSubscriptionArguments in .NET Reference.

Public Method GetHashCodeReturns a hash code for the current object.

 

DISPID (Dispatch ID):

 

For more information, see GetHashCode in .NET Reference.

Public Method GetObjectData

 

DISPID (Dispatch ID):

 

For more information, see GetObjectData in .NET Reference.

Public Method GetServiceGets the service object of the specified type.

 

DISPID (Dispatch ID):

 

For more information, see GetService in .NET Reference.

Public Method GetServiceByNameGets the service object of the specified type, given by type name.

 

DISPID (Dispatch ID):

 

For more information, see GetServiceByName in .NET Reference.

Public Method GetTypeGets the Type of the current instance.

 

DISPID (Dispatch ID):

 

For more information, see GetType in .NET Reference.

Public Method IsKnownEventsSubscriptionHandleDetermines whether the given event subscription handle is known to this client.

 

DISPID (Dispatch ID):

 

For more information, see IsKnownEventsSubscriptionHandle in .NET Reference.

Public Method PullMultipleNotificationsAttempts to pull multiple OPC events subscribed to by the SubscribeEvents method, returning an array. Returns refresh or standard event notifications.

 

DISPID (Dispatch ID):

 

For more information, see PullMultipleNotifications in .NET Reference.

Public Method PullNotificationAttempts to pull an OPC event subscribed to by the SubscribeEvents method. Returns refresh or standard event notifications.

 

DISPID (Dispatch ID):

 

For more information, see PullNotification in .NET Reference.

Public Method PullNotificationListAttempts to pull multiple OPC events subscribed to by the SubscribeEvents method, returning a list. Returns refresh or standard event notifications.

 

DISPID (Dispatch ID):

 

For more information, see OpcLabs.EasyOpc.AlarmsAndEvents.ComTypes._EasyAEClient.PullNotificationList in .NET Reference.

Public Method QueryEventCategoriesFinds out events categories supported by the server. Server descriptor is used for specifying the OPC server. Queries event categories for given event types.

 

DISPID (Dispatch ID):

 

For more information, see QueryEventCategories in .NET Reference.

Public Method QuerySourceConditionsFinds out event conditions associated with the specified source name. Uses server descriptor for specifying the OPC server.

 

DISPID (Dispatch ID):

 

For more information, see QuerySourceConditions in .NET Reference.

Public Method RefreshEventSubscriptionForce a refresh for all active conditions and inactive, unacknowledged conditions whose event notifications match the filter of the event subscription.

 

DISPID (Dispatch ID):

 

For more information, see RefreshEventSubscription in .NET Reference.

Public Method remove_Disposed

 

DISPID (Dispatch ID):

 

For more information, see remove_Disposed in .NET Reference.

Public Method ResetSets the object properties back to their defaults.

 

DISPID (Dispatch ID):

 

For more information, see Reset in .NET Reference.

Public Method SubscribeEventsSubscribe to OPC events. Specify server descriptor and subscription parameters objects, "refresh when active" flag, and a callback method.

 

DISPID (Dispatch ID):

 

For more information, see SubscribeEvents in .NET Reference.

Public Method UnsubscribeAllEventsUnsubscribe from changes of all OPC events.

 

DISPID (Dispatch ID):

 

For more information, see UnsubscribeAllEvents in .NET Reference.

Public Method UnsubscribeEventsUnsubscribe from particular OPC event notifications.

 

DISPID (Dispatch ID):

 

For more information, see UnsubscribeEvents in .NET Reference.

Public Method ValueEqualsDetermines whether this instance has the same value as a given other instance.

 

DISPID (Dispatch ID):

 

For more information, see ValueEquals in .NET Reference.

Public Properties
Public Property AliasProviderThe alias provider to be used for resolving aliases by this component.

 

DISPID (Dispatch ID):

 

For more information, see AliasProvider in .NET Reference.

Public Property CustomReferenceCan be used to distinguish otherwise equal widgets.

 

DISPID (Dispatch ID):

 

For more information, see CustomReference in .NET Reference.

Public Property DisplayStringThe display string for the current object.

 

DISPID (Dispatch ID): 0

 

For more information, see ToString in .NET Reference.

Public Property InstanceParametersContains parameters that influence the behavior of just this instance of the component.

 

DISPID (Dispatch ID):

 

For more information, see InstanceParameters in .NET Reference.

Public Property IsolatedSpecifies that you wish that the EasyAEClient object instance works with an "isolated" connection to the OPC server, i.e. one that is not shared with other instances.

 

DISPID (Dispatch ID):

 

For more information, see Isolated in .NET Reference.

Public Property IsolatedParametersContains parameters that influence the behavior of the component when it is isolated.

 

DISPID (Dispatch ID):

 

For more information, see IsolatedParameters in .NET Reference.

Public Property LicenseInfoProvides dictionary of license data fields and their values.

 

DISPID (Dispatch ID):

 

For more information, see LicenseInfo in .NET Reference.

Public Property NotificationQueueCapacityCapacity of the notification queue.

 

DISPID (Dispatch ID):

 

For more information, see NotificationQueueCapacity in .NET Reference.

Public Property NotificationQueueIdleTimeToSleepThe idle time before the internal thread executing the queued notifications is stopped (in milliseconds).

 

DISPID (Dispatch ID):

 

For more information, see NotificationQueueIdleTimeToSleep in .NET Reference.

Public Property PullNotificationQueueCapacityCapacity of the event pull queue for notifications.

 

DISPID (Dispatch ID):

 

For more information, see PullNotificationQueueCapacity in .NET Reference.

Public Property QueueNotificationsDetermines whether the component will deliver all notifications in a queued manner.

 

DISPID (Dispatch ID):

 

For more information, see QueueNotifications in .NET Reference.

Public Property Site

 

DISPID (Dispatch ID):

 

For more information, see Site in .NET Reference.

Public Property SupportedTechnologiesGets the OPC technologies supported.

 

DISPID (Dispatch ID):

 

For more information, see SupportedTechnologies in .NET Reference.

Public Property ToStringReturns a string that represents the current object.

 

DISPID (Dispatch ID):

 

For more information, see ToString in .NET Reference.

Events
Public Event EventingFailureRaised when a failure in the eventing infrastructure occurs.
Public Event NotificationRaised for every OPC event subscribed to by the SubscribeEvents method. This method can be called whether this is a refresh or standard event notification.
See Also

EasyAEClient Object

 

 

Copyright © 2004-2024 CODE Consulting and Development, s.r.o., Plzen. All rights reserved. Web page: www.opclabs.com

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.