StructDelete

Removes an element from a structure.

StructDelete( struct, key [, indicatenotexisting ] )

Returns: Boolean

Argument Description
struct
struct, required

Structure contains element to remove.

Alias: structure, object

key
string, required

Element to remove

indicatenotexisting
boolean, optional

Alias: indicateExists

Examples

Member Function

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
);

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
);

See also