Last updated on
11 January 2022
|
Also applies to ColdFusion
Description
This function encodes the given string for safe output in LDAP Distinguished Names.
Returns
Encoded string
Category
Display and formatting functions
Syntax
encodeForDN (string, [,canonicalize])
History
ColdFusion (2018 release): Renamed parameter inputString to string.
Added in ColdFusion 10.
See also
Parameters
| Parameter | Description |
| string | Required. The string to encode. |
| canonicalize | 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 perform encoding. |
Example
<cfscript>
departmentId = "Human Resources <CTO>";
searchStart = "ou=" & encodeForDN(departmentId) & ",dc=uconn,dc=edu";
cfldap(
server = "ldap.uconn.edu",
action = "query",
name = "results" ,
start = "#searchStart#",
filter = "cn=Robert Jones" ,
attributes = "cn,description,o,title,mail,telephonenumber",
sort = "cn ASC");
</cfscript>