Command: raise_event

Syntax

raise_event <instance_id>,<event_strings>

Description

Raise an event to an OLE/ActiveX or browser client, in which Fire is embedded.

Parameters

• <instance_id>
  The instance id number. For OLE/ActiveX clients, this is the Service Object instance returned by the FireService Object GetId command method within the OLE client. It is used to identify which OLE instance is raising the event. For browser clients, this parameter should have any non-zero value.

• <event_strings>
  The event string to send to the client. For OLE/ActiveC clients, this may be one string value or an array of string values. For browser clients this should be one string value only.

Switches

• -syn
  If this switch is present, the system will wait for acknowledgement from the client before continuing. The default behavior is not to wait.

Notes

An OLE/ActiveX client will be a third-party development environment or other OLE client application, which has a FireService or ExistingFireService Object embedded in it. A browser client is a browser applet Java VM in which Fire is embedded.

For an OLE/ActiveX client, if instance_id does not reference a valid FireService Object, you will receive a warning message as follows:

"Warning: <n> is not a valid Xmarc(formerly Formida) Fire Service Object instance."

Examples

# Assuming a FireService Object with OLE instance id 1 exists
# This raises an event to the OLE client
raise_event 1, "TEST: Event String"

See Also