StructDelete()

Removes an element from a structure.

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


	StructDelete( struct=struct, key=string, indicateNotExisting=boolean );

Returns: Boolean

Argument Description

Argument	Description
struct _{struct, required}	edit Structure contains element to remove. _{Alias: structure, object}
key _{string, required}	edit Element to remove
indicateNotExisting _{boolean, optional}	edit `true`: if the key existed in the struct, `StructDelete` will return `true`; if the key did not exist in the struct, `StructDelete` will return `false`. `false` (default): irrespective of whether the key existed in the struct, `StructDelete` will return `true`. _{Alias: indicateExists}

struct

_{struct,

required}

edit

Structure contains element to remove.

_{Alias:
structure, object}

key

_{string,

required}

edit

Element to remove

indicateNotExisting

_{boolean,

optional}

edit

true: if the key existed in the struct, StructDelete will return true; if the key did not exist in the struct, StructDelete will return false.
false (default): irrespective of whether the key existed in the struct, StructDelete will return true.

_{Alias:
indicateExists}

Examples

edit

Non-Member Function

animals = {
	cow: "moo",
	pig: "oink",
	cat: "meow"
};

// Show current animals
Dump(
	label: "Current animals",
	var: animals
);

// Delete the key 'cat' from struct
StructDelete(animals, "cat");

// Show animals, cat has been deleted
Dump(
	label: "Animals with cat deleted",
	var: animals
);

StructDelete()

Examples

Non-Member Function

See also