MaxIDE.Events Object API



Identification

MaxIDE.Events

Description

This object is used as part of a project to manage events and messages in the database.

Functions

MessageQueueLog (MsgTo) Long

Parameters

MsgTo String

Specifies a unique identifier that the messages belong to.

Description

Retrieves the log size of the messages waiting for the specified unique identifier.

MessageQueueGet (MsgTo) Collection

Parameters

MsgTo String

Specifies a unique identifier that the messages belong to.

Description

Removes the queued messages for the specified unique identifier from the database and returns them in a VBA Collection.

MessageQueueAdd (MsgTo, Msg)

Parameters

MsgTo String

Specifies a unique identifier that the messages belong to.

 

Msg String

Specifies any message to be sent to the message queue.

Description

Adds a message to the message queue for the specified unique identifier.

GetEvents () Collection

Description

Retrieves all events currently in the log and returns them in a VBA Collection.

AddEvent (Source, Location, Message)

Parameters

Source String

Specifies a source value for the event to be added.

 

Location String

Specifies a location value for the event to be added.

 

Message String

Specifies a message value for the event to be added.

Description

Adds a new event to the log.

ClearEvents ()

Description

Clears all the events currently in the log folder.

Automation

Object:Init (self)

Parameters

self Object

A reference to the object.

Description

Optional event that is called when the object is initialized.

Object:Term (self)

Parameters

self Object

A reference to the object.

Description

Optional event that is called when the object is terminated.