UberFoX: 1 revision

2015-06-14T12:37:34Z

1 revision

← Older revision

Revision as of 12:37, 14 June 2015

UberFoX: 1 revision

2014-08-11T21:41:04Z

1 revision

← Older revision

Revision as of 21:41, 11 August 2014

UberFoX: Created page with "

 Escape( ,  )

=== Description === Add escapes to a string. === Parameters === ==== expression ==== The string to use. ==== custom ==== Opti..."

2013-09-13T16:18:28Z

Created page with "<pre> Escape( <expression>, <custom> ) </pre> === Description === Add escapes to a string. === Parameters === ==== expression ==== The string to use. ==== custom ==== Opti..."

New page

<pre>
Escape( <expression>, <custom> )
</pre>

=== Description ===

Add escapes to a string.

=== Parameters ===

==== expression ====

The string to use.

==== custom ====

Optional; A string containing characters to be escaped instead of escaping everything.

=== Return Value ===

Success: Returns a string with backslashes added. (' becomes \' and so on.).

Failure: Returns empty string.

=== Remarks ===

This adds escapes toa string regardless if the escape is valid or not so even # will be replaced with \#.

If you require more specific escape/unescape functions see the ones that deal with C/Sputnik specific escapes.

To properly escape and resolve Sputnik strings see [[Core Function ResolveStr|ResolveStr( <expression> )]].

=== Example ===

Escape everything
<syntaxhighlight lang="sputnik">
say Escape(@"Hello World!");
// Prints: \H\e\l\l\o\ \W\o\r\l\d\!
</syntaxhighlight>

Escape only 'l' and 'o' characters
<syntaxhighlight lang="sputnik">
say Escape(@"Hello World!", 'lo');
// Prints: He\l\l\o W\or\ld!
</syntaxhighlight>

[[Category:Core Function]]

Core Function Escape - Revision history

UberFoX: 1 revision

UberFoX: 1 revision

UberFoX: Created page with "
Escape( , )
=== Description === Add escapes to a string. === Parameters === ==== expression ==== The string to use. ==== custom ==== Opti..."