POOL MANAGEMENT(1e)

NAME

sn_pool_push - Push an existing pool or create a new one.
sn_pool_pop - Remove last initialized pool from the stack.
sn_get_main_pool - Get the root pool which is never released.

SYNOPSIS

sn_pool_push([pool])
sn_pool_pop()
sn_get_main_pool()

PARAMETERS

string

The string to be escaped.

RETURN

Returns the escaped string.

DESCRIPTION

This function returns a string after it has escaped every characters that needed to be.

This means that it adds a backslash in front of any of the characters listed below.

An escaped character is a character that invokes an alternative interpretation on subsequent characters in a character sequence (wikipedia). When adding an escaped character in front of another character, it changes its meaning. For example, when you add a backslash in frond of an "n", it means "new line". Those characters are the single or double quote, the backslash and the null character.

EXAMPLES

Note: In the followings examples, the _ between the { should be removed to make it work.

in:  res={_{addslashes("");}}.
out: res=.

in:  res={_{addslashes(1);}}.
out: res=1.

in:  res={_{addslashes("\\\"'");}}.
out: res=\\\\\"\'.

AUTHOR

Written by Pierre Laplante and Caroline Laplante