Value::GetTextHTML

Value::GetTextHTML
SF_INLINE bool GetTextHTML(Value* pval) const;
Description

GetTextHTML retrieves the HTML code of a TextField. If the textField is displaying HTML, then the HTML code is returned. If not displaying HTML, then it is equivalent to GetText(). The Value holding the HTML text reference MUST be destroyed before the runtime dies since the Object’s memory will be invalid due to heap deallocation.

Parameters
Parameters 
Description 
Value* pval 
The holder for the returned string. 
Return Value

Returns true if the HTML text was retrieved, otherwise false. A false value will also be returned if the TextField was unloaded from the stage.