MsgPlus::RemoveFormatCodes

The MsgPlus::RemoveFormatCodes function removes Messenger Plus! Live formatting attributes from a string.

Syntax

[string] RemoveFormatCodes(
    [string] Text
);

Parameters

Text

[string] Text to filter.

Return Value

A string containing the "cleaned" version of the text. If no format code was detected, the return value is identical to the Text parameter.

This function typically fails for the following reason:

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

Remarks

Through out its existence, Messenger Plus! came up with three different sets of control codes (each born from a specific necessity):

• IRC codes. These are control characters using special ASCII values. They were modeled on mIRC.
• IRC codes for contact names. Derived from IRC codes, these codes were added to bypass new filters set for contact names on the Messenger servers.
• BBCode. These tags resemble the way formatting is added in HTML documents. They were modeled on phpBB.

Because of the list of tags and their possible combinations would be pretty long and because new control codes may be added in the future, it is recommended that you use this function to filter out every possible code from the strings your script manipulates.

Function Information

See Also

MsgPlus Object.