StructAppend()

Appends all the data from struct2 into struct1, replacing duplicate keys unless specified by the overwrite flag

StructAppend( Struct1=struct, Struct2=struct, OverwriteFlag=boolean );

Returns: Boolean

Argument Description Default
Struct1
struct, required

Structure to which struct2 is appended.
Struct2
struct, required

Structure that contains the data to append to struct1
OverwriteFlag
boolean, optional
  • true (default): values in struct2 overwrite corresponding values in struct1.

true

Examples

Non-Member Function

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

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

// Create a new animal
newAnimal = {
	cat: "meow"
};

// Append the newAnimal to animals
StructAppend(animals, newAnimal);

// Show animals, now includes cat
Dump(
	label: "Animals with cat added",
	var: animals
);

See also