structDelete

Removes an element from a structure.

structDelete(structure, key [, indicateNotExisting]) → returns boolean

structDelete Argument Reference

structure string
Required

Structure or a variable that contains one. Contains element
to remove

key string
Required

Element to remove

indicateNotExisting boolean
Default: false

When true this function will return true only if they key that will be deleted existed. When false (default) this function will return true if the key is successfully removed.
Values:
  • true
  • false

Examples sample code invoking the structDelete function

Creates a struct then removes a key

someStruct = {a=1,b=2};
structDelete(someStruct, "a");
writeDump(someStruct);

Fork me on GitHub