O4WEscape routine [Revelation On-Line Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

====== O4WEscape routine     ======


 
==== Description ====
 
Allows for the encoding of a string to a particular environment.
 
==== Syntax ====
 
O4WEscape(value, type)
 
==== Parameters ====
 
The function has the following parameters:

^Parameter^Description^
|value|The string to be encoded.|
|type| The encoding type|

^Encoding Type Value^Encoding Type O4WEquates Insert record value^
|0|O4W_ESCAPE_HTML$|
|1|O4W_ESCAPE_URL$|
|3|O4W_ESCAPE_URL_COMPONENT$|
|4|O4W_ESCAPE_ID$|
|null|O4W_ESCAPE_JS$|


 
==== Remarks ====
 
 
Note that O4W normally takes care of encoding strings as needed; however, it is up to the developer to use valid strings for "name" and "ID" parameters for the O4W calls, and calling O4WEscape with the O4W_ESCAPE_ID$ parameter is one way to ensure that a name or ID is valid.