User Guide Cancel

StructKeyList

 

Description

Extracts keys from a ColdFusion structure.

Returns

A list of keys; if structure does not exist, ColdFusion throws an exception.

Category

Syntax

StructKeyList(structure [, delimiter])
StructKeyList(structure [, delimiter])
StructKeyList(structure [, delimiter])

See also

Structure functionsModifying a ColdFusion XML object in the Developing ColdFusion Applications

Parameters

Parameter

Description

structure

Structure from which to extract a list of keys.

delimiter

Optional.  Character  that separates keys in  list . The default value is  comma .

Example

<cfscript>
myStruct=StructNew();
myStruct = {a:1,b=2,c=3,d=4,e=5};
myKeyList=StructKeyList(myStruct);
WriteOutput(myKeyList & " | ");
try{
StructKeyList(someStruct);
}
catch (any s){
WriteOutput(s.message);
}
</cfscript>
<cfscript> myStruct=StructNew(); myStruct = {a:1,b=2,c=3,d=4,e=5}; myKeyList=StructKeyList(myStruct); WriteOutput(myKeyList & " | "); try{ StructKeyList(someStruct); } catch (any s){ WriteOutput(s.message); } </cfscript>
<cfscript>
       myStruct=StructNew();
       myStruct = {a:1,b=2,c=3,d=4,e=5};
       myKeyList=StructKeyList(myStruct);
       WriteOutput(myKeyList & " | ");
       try{
             StructKeyList(someStruct);
       }
       catch (any s){
             WriteOutput(s.message);
       }
</cfscript>

Output

a,b,c,d,e | Variable SOMESTRUCT is undefined.

Using member function

<cfscript>
myStruct = {a:1,b=2,c=3,d=4,e=5};
myKeyList=myStruct.keyList(";");
WriteOutput(myKeyList);
</cfscript>
<cfscript> myStruct = {a:1,b=2,c=3,d=4,e=5}; myKeyList=myStruct.keyList(";"); WriteOutput(myKeyList); </cfscript>
<cfscript>
       myStruct = {a:1,b=2,c=3,d=4,e=5};
       myKeyList=myStruct.keyList(";");
       WriteOutput(myKeyList);
</cfscript>

Get help faster and easier

New user?