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: /* Remarks */

2013-09-13T17:27:58Z

Remarks

← Older revision		Revision as of 17:27, 13 September 2013
Line 41:		Line 41:
	=== Remarks ===		=== Remarks ===

−	~~None~~	+	See [[Core Function StripCSlashes\|StripCSlashes( <str> )]].

	=== Example ===		=== Example ===

UberFoX: Created page with "

 AddCSlashes( ,  )

=== Description === Escape a string with slashes in a C style. === Parameters === ==== str ==== The string to be escaped. ===..."

2013-09-13T17:18:55Z

Created page with "<pre> AddCSlashes( <str>, <charlist> ) </pre> === Description === Escape a string with slashes in a C style. === Parameters === ==== str ==== The string to be escaped. ===..."

New page

<pre>
AddCSlashes( <str>, <charlist> )
</pre>

=== Description ===

Escape a string with slashes in a C style.

=== Parameters ===

==== str ====

The string to be escaped.

==== charlist ====

A list of characters to be escaped. If charlist contains characters \n, \r etc., they are converted in C-like style, while other non-alphanumeric characters with ASCII codes lower than 32 and higher than 126 converted to octal representation.

When you define a sequence of characters in the charlist argument make sure that you know what characters come between the characters that you set as the start and end of the range.

<syntaxhighlight lang="sputnik">
echo addcslashes('foo[ ]', 'A..z');
// output: \f\o\o\[ \]
// All upper and lower-case letters will be escaped
// ... but so will the [\]^_`
</syntaxhighlight>

Also, if the first character in a range has a higher ASCII value than the second character in the range, no range will be constructed. Only the start, end and period characters will be escaped. Use the Asc() function to find the ASCII value for a character (or AscW() for Unicode character).

<syntaxhighlight lang="sputnik">
echo addcslashes("zoo['.']", 'z..A');
// output: \zoo['\.']
</syntaxhighlight>

Be careful if you choose to escape characters 0, a, b, f, n, r, t and v. They will be converted to \0, \a, \b, \f, \n, \r, \t and \v. In Sputnik \0 (NULL), \r (carriage return), \n (newline), \f (form feed), \v (vertical tab) and \t (tab) are predefined escape sequences, while in C all of these are predefined escape sequences.

=== Return Value ===

Returns the escaped string.

=== Remarks ===

None

=== Example ===

charlist like "\0..\37", which would escape all characters with ASCII code between 0 and 31.

<syntaxhighlight lang="sputnik">
echo addcslashes("Cat and Dog", @"\0..\37!@\177..\377");
// Prints: \Cat and \Dog
</syntaxhighlight>

Perhaps the following is a more efficient JavaScript escape function:
<syntaxhighlight lang="sputnik">
function jsEscape($str)
{
return addcslashes($str, "\\\'\"&\n\r<>");
}
</syntaxhighlight>

[[Category:Core Function]]

Core Function AddCSlashes - Revision history

UberFoX: 1 revision

UberFoX: 1 revision

UberFoX: /* Remarks */

UberFoX: Created page with "
AddCSlashes( , )
=== Description === Escape a string with slashes in a C style. === Parameters === ==== str ==== The string to be escaped. ===..."