Whatever message this page gives is out now! Go check it out!
clear
Last update:
May 18, 2026
Removes all elements from the set.
Description
Removed all elements from a set. After clear(), the set is empty. set.isEmpty returns true and set.size returns zero.
Returns
Void
Category
ColdFusion Set member methods
Function syntax
set.clear()Parameters
| Parameter | Description |
|---|---|
| — | None. |
See also
Example
The following example uses this API in
cfscript (syntax: set.clear()).
<cfscript>
s = setNew();
s.add(1);
s.add(2);
s.clear();
writeOutput(s.size()); // 0
</cfscript>
Real-world example
Reset a session-scoped cache of dismissed alert IDs when the user clicks Dismiss all.
<cfscript>
if (!structKeyExists(request, "dismissedAlertIds") || isNull(request.dismissedAlertIds)) {
request.dismissedAlertIds = setNew();
}
function recordDismissedAlert(required string alertId) {
request.dismissedAlertIds.add(alertId);
}
function dismissAllAlerts() {
request.dismissedAlertIds.clear();
}
recordDismissedAlert("promo-spring-2025");
recordDismissedAlert("maintenance-notice-42");
writeOutput(request.dismissedAlertIds.size()); // 2
dismissAllAlerts();
writeOutput(request.dismissedAlertIds.isEmpty()); // true
</cfscript>
We're glad. Tell us how this page helped.
We're sorry. Can you tell us what didn't work for you?
Share additional feedback to help us improve.
0/255
|
