Encodes the given string for safe use in an XPath Query.

string.encodeForXPath( string [, canonicalize ] )

Returns: String

Argument Description
string, required

string to encode

boolean, optional

If set to true, canonicalization happens before encoding.

If set to false, the given input string will just be encoded. The default value for canonicalize is false.

When this parameter is not specified, canonicalization will not happen. By default, when canonicalization is performed, both mixed and multiple encodings will be allowed.

To use any other combinations you should canonicalize using canonicalize method and then do encoding.


There are currently no examples for this function

See also