world.FixupHTML

MUSHclient script function (Method)

Fixes up text for writing as HTML

Prototype

BSTR FixupHTML(BSTR StringToConvert);

Data type meanings

Description

This translates text so that it can be logged as HTML.

It will translate "<", ">" and "&" to the HTML equivalents (eg. &lt; ), otherwise a line like this: "go <north>" would not log correctly as HTML.

This is intended for use in scripts that are used to log to the log file, where you are writing out a log file in HTML.

VBscript example

world.note world.FixupHTML ("I will go <north> here")

Jscript example

world.note(world.FixupHTML("I will go <north> here"));

PerlScript example

$world->note($world->FixupHTML("I will go <north> here"));

Python example

world.note(world.FixupHTML("I will go <north> here"))

Lua example

Note(FixupHTML("I will go <north> here"))

Return value

The supplied string with the following characters replaced with the HTML "escaped" equivalents:

< &lt;
> &gt;
& &amp;
" &quot;

Related topic

Utilities