MsgPlus::LogEvent

The MsgPlus::LogEvent function generates an event to be added in the Event Viewer of Messenger Plus! and the Event File if configured.

Syntax

LogEvent(
    [string] Origin,
    [string] Description,
    [enum] Icon
);

Parameters

Origin

[string] Origin of the event. Typically, this parameter should be set to the name of the script.

Description

[string] Description of the event. It is recommended to keep the text short, although no size limit is enforced.

Icon

[enum] Number specifying the icon to use in the Event Viewer for this event. Can be one of the following:

EVICON_ONLINE (0) EVICON_OFFLINE (1) EVICON_AWAY (2) EVICON_BUSY (3) EVICON_BLOCKED (4) EVICON_PLUS (5) EVICON_NAME (6) EVICON_PSM (7) EVICON_MEDIA (8) EVICON_EMAIL (9) EVICON_MUSIC (10)

Online Buddy Icon Offline Buddy Icon Away Buddy Icon Busy Buddy Icon Blocked Buddy Icon Messenger Plus! Logo Name Change Icon Personal Message Change Icon Media Change Icon New Emails Icon Music Change Icon

Return Value

No value is returned by this function.

This function typically fails for the following reason:

• The number specified for Icon is not in the range of accepted values.

Remarks

Only meaningful events should be reported with this function. If you plan on having a lot of different notifications, it is considered good practice to create a configuration window to let the user filter the list of possible events.

Messenger Plus! 4.23 and earlier: enumeration names are not available, numbers must be used instead.

Function Information

See Also

MsgPlus Object.