struct.delete()

edit

Removes an element from a structure.

Since Lucee 6, this member function .delete() now returns the modified struct

struct.delete( key=string, indicateNotExisting=boolean )

Returns: Struct

Argument Description
key
string, required 		edit

Element to remove
indicateNotExisting
boolean, optional 		edit

Whether to show an error if the key does not exist

Alias: indicateExists

Examples

edit 
	animals = {
	    cow: "moo",
	    pig: "oink",
	    cat: "meow"
 	 };
	// Show current animals
	Dump(
		label: "Current animals",
		var: animals
	);
	// Delete the key 'cat' from struct
	animals.delete("cat");
	// Show animals, cat has been deleted
	Dump(
		label: "Animals with cat deleted",
		var: animals
	);

See also