Whatever message this page gives is out now! Go check it out!

StructClear

Last update:
May 18, 2026

Description

Removes all data from a structure.

Returns

True, on successful execution; False, otherwise.

Category

Syntax

StructClear(structure)

See also

Structure functionsModifying a ColdFusion XML object in the Developing ColdFusion Applications

History

ColdFusion MX: Changed behavior: this function can be used on XML objects.

Parameters

Parameter
Description
structure
Structure to clear.

Example

<cfscript>
       myStruct={a:1,b:2,c:3,d:4,e:5}; //Define the structure keys
       WriteOutput("Struct with data:");
       WriteDump(myStruct);
       StructClear(myStruct); //Remove data from the struct myStruct
       WriteOutput("Struct after data removal:");
       WriteDump(myStruct);
</cfscript>

Output

Figure: structclear output
structclear output

Using member function

<cfscript>
       myStruct={a:1,b:2,c:3,d:4,e:5}; //Define the structure keys
       WriteOutput("Using member functions");
       WriteOutput(myStruct.clear());
</cfscript>

Share this page

Was this page helpful?
We're glad. Tell us how this page helped.
We're sorry. Can you tell us what didn't work for you?
Thank you for your feedback. Your response will help improve this page.

On this page