encodeForXPath

Returns an encoded string for safe use in an XPATH query.

encodeForXPath(string [,canonicalize]); → returns string

  1. CFDocs
  2. Functions
  3. ColdFusion 11 New Functions and Tags
  4. encodeForXPath
  5. CF11+
  6. Lucee4.5+
  7. BoxLang 1.0.0+
  8. 0 Issue
  9. Edit
See Also:   encodeForXML   Canonicalize

Argument Reference

string string
Required

The string to encode.

canonicalize boolean

If set to true, canonicalization happens before encoding.
If set to false, the given input string will just be encoded.
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.

Compatibility

BoxLang:

Version 1.0.0+ Requires the bx-esapi module.

Examples
Sample code invoking the encodeForXPath function 

encodeForXPath("'or 1=1",false)

Expected Result: 'or 1=1

Signup for cfbreak to stay updated on the latest news from the ColdFusion / CFML community. One email, every friday.

Fork me on GitHub