Classes
| Class | Description | |
|---|---|---|
 | AEConditionState | AEConditionState objects are returned in the GetConditionState client call for each requested event attribute. |
| AlarmEventServer | Alarm / Events Server. Each client connect creates an instance of this class. |
| AppPlugin | The MAIN class of the DA / AE plug-in DLL. The methods called from the UA generic server are implemented in this class. |
| BrowseNodeInfo | Node info returned in browse |
| CacheItemInfo | Item info from the generic server cache |
| CallbackData | AE event notification data |
| ConditionDef | Defiens one AE event condition |
| DeviceItemValue | Item data passed in WriteItems() |
| EventArea | Node information for an Event Area. This class is used in the DA server configuration to add OPC items as event sources. Depending on the application this class may have to be extended. |
| EventAreaBrowser | Summary description for EventAreaBrowser. |
| EventAttributeDef | AE event attribute definition. |
| EventCategoryDef | AE event category definition. |
| EventCondition | Summary description for EventCondition. |
| EventData | Data passed to the client in an event callback |
| EventFilterDef | Defines the filter parameters for a specific type of event |
| EventSource | Node information for an Event Source. |
| EventSubscription | EventSubscription class sample implementation. Handles the event subscription client calls and OnEvent callbacks. There is an instance for subscription created by the clients. The public members are used by the generic server and may not be changed. Events are filtered according the current filter settings. The sample implementation is OPC AE V1.1 compliance tested. |
| EventSubscription.EventCatData | |
| EventSubscriptionBaseHandlers | |
| GenericServer | This class defines the generic DA server interface. See chapter Server Structure for an explanation of the server data and thread structure. The GenericServer class provides a set of generic DA server callback methods. These methods can be used to read information from the generic server or change data in the generic DA server. It also defines classes and enumerators used in the data exchange with the generic server and contains a standard implementation of the methods called by the generic DA server. The class AppPlugin inherits from this class and defines method overloads for the methods that need to be implemented for a specific application. |
| HRESULTS | HRESULTS enumerator. Defines the OPC error codes. |
| LogFile | |
| ServerInstanceInfo | Information from the generic server about the current server instances. For DA servers there is an instance for each client connection. For UA servers an instance is a session. The application may use this information to give some clients special access rights or restrict the access for some clients. E.g. deny write access or read/write access to certain items. For DA servers the information may not be helpful since the always available user account information may be the same for all clients, the client application neeed to set define a name using the SetClientName OPC function. For UA server the user account information is either "ANonymous", the user name or the certificate name, depending on the endpoint configuration. |
| SubConditionDef | |
| SubscriptionList |
Structures
| Structure | Description | |
|---|---|---|
 | SrvRegDef | Server information structure returned by GetServerRegistryDef. |
Delegates
| Delegate | Description | |
|---|---|---|
 | AddItem | Generic server callback to add a new item to the server's address space. |
| CoInitForThread | Definition of the generic server callback method. DON'T USE IT DIRECTLY. Use the instance cbCoInitForThread. |
| DeleteItem | Generic server callback to remove an unreferenced item from the server's address space. |
| DlgAckCondition | |
| DlgAddSource | |
| DlgBrowseOPCAreas | |
| DlgCancelRefresh | |
| DlgChangeBrowsePosition | |
| DlgCreateEventAreaBrowser | |
| DlgCreateEventCondition | |
| DlgCreateEventServer | |
| DlgCreateEventSubscription | |
| DlgDisableConditionByArea | |
| DlgDisableConditionByArea2 | |
| DlgDisableConditionBySource | |
| DlgDisableConditionBySource2 | |
| DlgEnableConditionByArea | |
| DlgEnableConditionByArea2 | |
| DlgEnableConditionBySource | |
| DlgEnableConditionBySource2 | |
| DlgFindSource | |
| DlgGetEnableStateByArea | |
| DlgGetEnableStateBySource | |
| DlgGetFilter | |
| DlgGetKeepAlive | |
| DlgGetQualifiedAreaName | |
| DlgGetQualifiedSourceName | |
| DlgGetReturnedAttributes | |
| DlgGetState | |
| DlgHandleConditionStateChange | |
| DlgHandleStateChange | |
| DlgQueryConditionNames | |
| DlgQueryEventAttributes | |
| DlgQueryEventCategories | |
| DlgQuerySourceConditions | |
| DlgQuerySubConditionNames | |
| DlgRefresh | |
| DlgRemoveSubscription | |
| DlgSelectReturnedAttributes | |
| DlgSendConditionEvent | |
| DlgSendSimpleEvent | |
| DlgSendTrackingEvent | |
| DlgSetFilter | |
| DlgSetKeepAlive | |
| DlgSetState | |
| GetItemInfo | Generic server callback to get inforamtion about one item. |
| GetRefreshNeed | Generic server callback to get a list of item that need to be refreshed. |
| GetServerInfo | Generic server callback to get information about the current server status/usage. |
| GetServerInstanceInfo | Generic server callback to get information about one or all server instances. There is a server instance for each client connection. |
| OnEvent | Definition of the generic server callback method. DON'T USE IT DIRECTLY. Use the instance cbOnEvent. clientSubscription: the client handle for the subscription object sending the event notifications. refresh: TRUE if this is a subscription refresh. lastRefresh: TRUE if this is the last subscription refresh in response to a specific invocation of the EventSubscriptionMgt.Refresh method. count : Number of event notifications. A value of zero indicates this is a keep-alive notification (see EventSubscriptionMgt2.SetKeepAlive() ). events : Array of event notifications. |
| SetItemValue | Generic server callback to change an item value. |
| SetServerState | Generic server callback to change the server state. |
| ShutDownRequest | Generic server callback to request a shout down. |
Enumerations
| Enumeration | Description | |
|---|---|---|
 | BROWSEMODE | Browse Mode enumerator |
| ClientUpdateHandlingMode | Controls the client update handling in the generic server. Professinal Edition only. The Standard Edition only supports the 'ManyChanges' mode. |
| ConditionState | Event Server condition state. The ConditionState defines flag bits that are used to indicate the state of the conditon. Multiple bits may be set in any combination. |
| EventBrowseType | Alarms/Events Browse type definition for filters. Event sources are organized in a hierarchical structure of areas. Areas can be defined as required and must not correlate to branches in the DA server address space. However, for simplicity reasons the sample implementation has the eventsorces in areas that correlate to the DA server branch structure. |
| EventChangeMask | The Change Mask defines flag bits. It is used in OnEvent callbacks to indicates to the client which properties of the condition have changed, to have caused the server to send the event notification. One or more bits may be set in a mask. |
| EventFilter | Types of filtering an event server may support |
| EventType | Event Types |
| ExeStartMode | Determines how the server starts when the EXE file is started. This definition has no effect if the server is started from DCOM due to a client connect or when it's registered to run as a service. The server terminates after the last client disconnects, independent of this definition. |
| OPCAccess | OPC defined item read/write definitions |
| OPCBROWSEDIRECTION | Browse direction enumerator used in the OPC DA browser and The OPC AE area browser. |
| OPCBROWSETYPE | Enumerator for for browse mode selction |
| OPCQuality | OPC defined item quality values |
| OpcServerState | Possible OPC server states |
| OpcSeverityLevel | OPC recommended base values for OPC severity levels. |
| OPCV3BrowseType | OPC DA V3 browse modes |
| OPCV3NodeType | OPC DA V3 browse node information |
| Operator | |
| ValidateMode | Item Validate mode enumerator |
| ValidateReason | Item Validate mode enumerator |
| WriteCacheUpdateHandlingMode | Controls the cache update in the Write handling. Professinal Edition only. The Standard Edition only supports the GenericServer mode. |