ChatWnd::HistoryText_GetTextRange

The ChatWnd::HistoryText_GetTextRange function returns the desired portion of text from the message history area (where received messages are displayed), with or without emoticon codes.

Syntax

[string] HistoryText_GetTextRange(
    [number] StartIdx,
    [number] EndIdx,
    [boolean,optional] AddObjectCodes,
);

Parameters

StartIdx

[number] Index of the first character included in the text range.

EndIdx

[number] Index following the last character included in the text range.

AddObjectCodes

[boolean,optional] Specifies if objects such as emoticons are to be replaced by their text representation. The default for this parameter is true. If this parameter is true, the length of the text returned may be different than the specified text range as objects normally count for 1 blank character.

Return Value

The portion of text corresponding to the range specified in the parameters.

This function typically fails for the following reason:

• The StartIdx or EndIdx parameter is inferior to 0.
• The range specified is inferior to 0.
• The ChatWnd object refers to a window that has been destroyed.

Remarks

An "object" is anything that is not text. For example, file transfers and separator lines are represented with objects in the message history. Such objects may have no text representation at all of internal character codes such as "*".

Function Information

See Also

ChatWnd Object, HistoryText_GetCurSelStart, HistoryText_GetCurSelEnd.