Description: Create a new dictionary with contents identical to an existing dictionary. It is anticipated that this function will be used rarely, since in most cases it will be more efficient to hand off a reference to a dictionary rather than build a duplicate of it.
In the case of a complex dictionary that contains other dictionaries within it, the optional Boolean parameter, deep, controls whether the copy should also contain the sub dictionaries, as does the original, or if it should contain copies of those dictionaries.
Returns: Dictionary
Usage: Script
Format: NewDictionary = DictionaryCopy( dictionary, [deep], [acyclic], [lock] );
Parameters:
Dictionary
{ Dictionary } { required } { no default
}
The name of the
dictionary.
Deep { Boolean } { optional
} { default: false
}
An optional Boolean
(default value: FALSE) that causes all linked dictionaries, if any, to be copied
as well.
Acyclic { Boolean } { optional
} { default: false
}
An optional Boolean
(default value: FALSE) indicating that cyclic links within the dictionary
structure should not be included in the copy.
Lock { Boolean } { optional
} { default: false
}
An optional Boolean
(default value: FALSE) indicating that the contents of the dictionary copy are
to be constant.
See Also:
Dictionary, MetaData, DictionaryRemove, GetNextKey, GetKeyCount, HasMetaData, IsDictionary, ListKeys, RootValue