opcif_register()

   #include opcapi.h

   int opcif_register(
              int                interface_id,     /* in */
              const opcregcond   reg_cond,         /* in */
              long               *cond_id          /* out */
                     );

Parameters

interface_id

Specifies which interface instance is used.

reg_cond

• Messages

  Defines the combination of message attributes that are checked. NULL registers for all messages

• Message Events

  Defines an event mask and the restriction of message events of messages for certain operators.

• Application Responses

  Defines an application response specified by the application response ID.

cond_id

Returns an ID to reference this condition in a subsequent call to opcif_unregister(). NULL is allowed if the API user does not require the ID (for example, if opcif_unregister()is not called subsequently).

Description

The function opcif_register() is used by an external application to register for the following attributes:

• Message Attributes

  HPOM supports registration for message type, message group, node name, object, severity, and application attributes. You can also combine attributes (logical AND), and pipe (|) within an attribute (logical OR). Multiple registrations (logical OR of registration conditions) are also possible using a sequence of API calls.

  The following attributes are supported:

  • OPCREG_MSGTYPE
  • OPCREG_GROUP
  • OPCREG_NODENAME
  • OPCREG_OBJECT
  • OPCREG_SEVERITY
  • OPCREG_APPLICATION

Return Values

OPC_ERR_OK

OK.

OPC_ERR_CANT_INIT

Initialization of queues failed.

OPC_ERR_INVALID_INTERFACE_ID

No such interface opened.

OPC_ERR_CANT_INFORM_MSGA

Informing message agent failed.

Versions

HPOM for Windows 8.00 and higher