The following tables list the members exposed by OpcEventServer.
Public Constructors
| Name | Description | |
|---|---|---|
 | OpcEventServer Constructor | Overloaded. |
Public Fields
| Name | Description | |
|---|---|---|
 | AuthenticationWindowsIntegrated | |
| PreferredEndpoint | Only with UA option. Use this endpoint at connect if possible. |
| UaAccessWithoutSecurityPreferred | Only with UA option. Request to access the UA server with least security if true, otherwise with highest. |
Public Properties
| Name | Description | |
|---|---|---|
 | ConnectThroughNIOS | If TRUE a local OPC server is connected using NetInterop Services |
 | ErrorsAsExecptions | If TRUE all errors throw an OPCException instead of returning a HRESULT error code. |
| HostInfo | Server access credentials and machine name. |
| onNotifyUntrustedCertificate | handler that is called when the server certificate is untrusted |
| ServerName | ProgID of the connected server. |
| uaAEWrapper | Only with UA option. UA wrapper instance. The applicaiton can use this link to access UA wrapper methods directly. The link is null for instancs of non-UA servers. |
| UaAppConfigFileAutoCreate | If not null then an application configuration file is created unless it already exists. The defined name is used as the appliction name. |
| UaConfigFileName | Only with UA option. The name of the file with the UA client configuration. The name can be an absolute file path or a file name relative to the application executable directory. When the class instance is created the name is set to xxx.Ua.Config.Xml with xxx being the name of the application executable. The application can overwrite the name before Connect() is called. |
| UaNamespaceURIs | NamespaceURIs that match the NodeIDs persisted in the client application. If the application doesn't set this property before Connect() then the URIs are tried to be loaded from the file app.url.XML in the same directory as the app.exe executable. url is the UA server URL without the xxx:// This XML file is auto-generated at Connect() if the application didn't set this property. |
| UaTraceMask | Mask of enabled UA trace events |
| Version | Version number of the OPCAE.NET wrapper layer. |
Public Methods
| Name | Description | |
|---|---|---|
 | AckCondition | Overloaded. The client uses the AckCondition method to acknowledge one or more conditions in the Event Server. The client receives event notifications from conditions via the OnEvent callback. This AckCondition method specifically acknowledges the condition becoming active or transitioning into a different sub-condition (and no other state transition of the condition). One or more conditions belong to a specific event source – the source of the event notification. For each condition-related event notification, the corresponding Source, Condition Name, Active Time and Cookie is received by the client as part of the OnEvent callback parameters. |
| ChangeUser | Signal the server that the client has changed the user credentials of its proxy blanket. |
| Connect | Overloaded. Connect to the named OPC Server on the named machine |
| CreateAreaBrowser | Create an OPCEventAreaBrowser object on behalf of this client and return the interface to the Client. This object will support the IUnknown and IOPCEventAreaBrowser interfaces. The client can use this interface to browse the process areas available from the server as described in the IOPCEventAreaBrowser interface shown below. If the OPC Event Server does not support browsing of the process area space, then this method will fail. The client may create multiple OPCEventAreaBrowser objects in order to support concurrent access to multiple levels, in the case of a hierarchical area name space. The OPCEventAreaBrowser uses conventional reference counting and thus will be deleted with all interfaces to it are released. |
| DisableConditionByArea | Places the specified process areas into the disabled state. Therefore, the server will now cease generating condition-related events for these conditions. The effect of this method is global within the scope of the event server. Therefore, if the server is supporting multiple clients, the conditions are disabled for all clients, and they will stop receiving the associated condition-related events. |
| DisableConditionByArea2 | Places the specified process areas into the disabled state. Therefore, the server will now cease generating condition-related events for these conditions. The effect of this method is global within the scope of the event server. Therefore, if the server is supporting multiple clients, the conditions are disabled for all clients, and they will stop receiving the associated condition-related events. This is an optional function that's not supported by all servers. |
| DisableConditionBySource | Places all conditions for the specified event sources into the disabled state. Therefore, the server will no longer generate condition-related events for these conditions. The effect of this method is global within the scope of the event server. Therefore, if the server is supporting multiple clients, the conditions are disabled for all clients, and they will stop receiving the associated condition-related events. |
| DisableConditionBySource2 | Places all conditions for the specified event sources into the disabled state. Therefore, the server will no longer generate condition-related events for these conditions. The effect of this method is global within the scope of the event server. Therefore, if the server is supporting multiple clients, the conditions are disabled for all clients, and they will stop receiving the associated condition-related events. This is an optional function that's not supported by all servers. |
| Disconnect | Disconnect from the OPC server. The COM interface are released. |
| EnableConditionByArea | Places the specified process areas into the enabled state. Therefore, the server will now generate condition-related events for these conditions as long as the source itself is enabled and no containing area in its hierarchy is disabled. The effect of this method is global within the scope of the event server. Therefore, if the server is supporting multiple clients, the conditions are enabled for all clients, and they will begin receiving the associated condition-related events. |
| EnableConditionByArea2 | Places the specified process areas into the enabled state. Therefore, the server will now generate condition-related events for these conditions as long as the source itself is enabled and no containing area in its hierarchy is disabled. The effect of this method is global within the scope of the event server. Therefore, if the server is supporting multiple clients, the conditions are enabled for all clients, and they will begin receiving the associated condition-related events. This is an optional function that's not supported by all servers. |
| EnableConditionBySource | Places all conditions for the specified event sources into the enabled state. Therefore, the server will now generate condition-related events for these conditions. The effect of this method is global within the scope of the event server. Therefore, if the server is supporting multiple clients, the conditions are enabled for all clients, and they will begin receiving the associated condition-related events. |
| EnableConditionBySource2 | Places all conditions for the specified event sources into the enabled state. Therefore, the server will now generate condition-related events for these conditions. The effect of this method is global within the scope of the event server. Therefore, if the server is supporting multiple clients, the conditions are enabled for all clients, and they will begin receiving the associated condition-related events. This is an optional function that's not supported by all servers. |
| GetConditionState | Returns the current state information for the condition instance corresponding to the Source and ConditionName. The OPCCONDITIONSTATE structure is defined below. See section 2.4 for a discussion of conditions and their states. |
| GetEnableStateByArea | Returns the current enable state and the effective enable state for each area specified in Areas. This is an optional function that's not supported by all servers. |
| GetEnableStateBySource | Returns the current enable state and the effective enable state for each specified source. This is an optional function that's not supported by all servers. |
| GetErrorString | Return the description for the specified error from the server. The this fails the error description is taken from the wrapper internal table. |
| GetLocaleID | Get the current default LocalID. ( IOPCCommon::GetLocaleID ) |
| GetStatus | Get the current status of the OPC Server. See OPC specs IOPCServer::GetStatus for details. |
| IsAvailableNT | Query the current security configuration of the OPC server to determine if the current server configuration provides OPC Security by NT credentials. |
| IsAvailablePriv | Query the current security configuration of the OPC server to determine if the current server configuration provides OPC Security by private credentials. |
| Logoff | Remove the private credential established by the previous call to Logon(). OPC Security reverts to the state before the first call of Logon(), there are no private credentials active for the client. |
| Logon | Changes the identity of the client application’s user. Future access to any security objects will be authorized with the new user’s credentials until a subsequent call to Logoff() or Logon(). For OPC Servers which also implement IOPCSecurityNT, access checking with NT credentials will be disabled until Logoff() is called. |
| QueryAvailableFilters | The QueryAvailableFilters method gives clients a means of finding out exactly which filter criteria are supported by a given event server. This method would typically be invoked before configuring thefilter on an OPCEventSubscription object. |
| QueryAvailableLocaleIDs | Query the LocaleIDs supported by the OPC Server. ( IOPCCommon::QueryAvailableLocaleIDs ) If any error occurs a ThrowExceptionForHR is thrown. |
| QueryConditionNames | 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. |
| QueryEventAttributes | Overloaded. Using the EventCategories returned by the QueryEventCategories method, client application can invoke the QueryEventAttributes method to get information about the vendor-specific attributes the server can provide as part of an event notification for an event within the specified event category. Simple servers may not support any vendor-specific attributes for some or even all EventCategories. Attributes of event notifications are described in OPC AE specification section 2.5.2. Some possible vendor-specific attributes are included in Appendix C of the OPC AE specification. |
| QueryEventCategories | The QueryEventCategories method gives clients a means of finding out the specific categories of events supported by a given server. This method would typically be invoked prior to specifying an event filter. Servers will be able to define their own custom event categories, but a list of recommended categories is provided. |
| QueryMinImpersonationLevel | Information method to help a client to determine the minimal impersonation level the server requires to gain proper access to secured data sources. |
| QuerySourceConditions | The QuerySourceConditions method gives clients a means of finding out the specific condition names associated with the specified source (e.g. FIC101).. Condition names are server specific. |
| QuerySubConditionNames | The QuerySubConditionNames method gives clients a means of finding out the specific sub-condition names which are associated with the specified condition name. Condition names are server specific. |
| SetClientName | Define a client name. ( IOPCCommon::SetClientName ) |
| SetLocaleID | Set the default LocaleId for this session. ( IOPCCommon::SetLocaleID ) |
| TranslateToItemIDs | Many OPC Alarm/Event servers are associated with OPC Data Access servers. Since these servers may provide a Data Access interface to some or all of the attributes associated with events, applications need the ability to determine the specific ItemID for one or more specific attribute ID codes given an associated source ID in order to be able to access the attribute via the Data Access interface. TranslateToItemIDs performs the required translation. This function will be useful for the case where the client wishes to use the OPC Data Access interface to subscribe to real-time data associated with a given event or alarm. Given an event source, and an array of associated attribute ID codes, return an array of the item ID strings corresponding to each attribute ID. The event source, along with the associated attribute IDs are returned as part of the IOPCEventSink::OnEvent callback mechanism. Attribute ID codes and descriptions for a given event category can also be queried via the IOPCEventServer::QueryEventAttributes function. The server must return a NULL string for those attribute IDs that do not have a corresponding item ID. |
| WriteUaLog | For internal use only. The method is called from the UA Option to pass trace notification to the application. |
Protected Methods
Public Events
| Name | Description | |
|---|---|---|
 | ShutdownRequested | ShutdownRequestEventHandler |
| UaTraceNotification | UA Trace Notifcation |