CreatePreset

Introduced

v1.0

Description

Creates a preset object from a preset name, family name, or path.

1) If the name only is given, it must be a valid path to a preset file.

2) If a name and family is given, then if the preset name is a valid path to a preset, the preset must belong to that family. If the preset name is not a valid path, the family is used to locate the preset.

3) If the path is given, it is used to locate the preset. This preset is then validated using the family, if given.

Scripting Syntax

oReturn = CreatePreset( Name, [Family], [Path] );

Return Value

Returns the preset object.

Parameters

Parameter Type Description
Name String Preset name.
Family String Preset family name.
Path String Path to preset.

See Also

LoadPreset SIAddPropEx