ChatWnd::DisplayInfoMessage

The ChatWnd::DisplayInfoMessage function displays a message in the "information area" of the chat window. This is the area where the "user is typing" message is displayed. If a message from Messenger Plus! (including any script) is already displayed, the message is placed in queue.

Syntax

DisplayInfoMessage(
    [string] Message,
    [int,optional] Duration,
    [boolean,optional] ForceNow
);

Parameters

Message

[string] Message to display. Emoticons will not be rendered, however, formatting codes (like [b][/b] for bold) can be used.

Duration

[int,optional] Duration of the message on screen, in milliseconds. If 0 or not specified, the default duration of Messenger Plus! is used (8 seconds, can be customized by the user).

ForceNow

[boolean,optional] Specifies if the message should be forced to be displayed right away (false by default). If true and a message is currently being displayed by Messenger Plus!, it is discarded and replaced by the new message. If more messages were already in queue, they are also discarded.

Return Value

No value is returned by this function.

This function typically fails for the following reason:

• The ChatWnd object refers to a window that has been destroyed.

Remarks

This function can be used to easily notify the user of an event related to the current chat window. It is particularly effective in Windows Live Messenger 8.5 and above as the "information area" in these versions of Messenger is more visible to the user.

It is recommended to leave the duration to its default. Also, the ForceNow parameter should be used in very specific situations only. Because it will clear the current queue of messages waiting to be displayed, this will possibly cause annoyances to the user as some messages may be missed.

Note: Messenger Plus! may restrict the maximum number of messages waiting in the queue. There is one queue per chat window, shared by Messenger Plus! and all the scripts. If the maximum number of messages is reached, new messages will be discarded automatically until the current message times-out to make room for new additions (notification messages are supposed to have a meaning in the near present only).

Function Information

See Also

ChatWnd Object, ResetInfoMessage.