LoadFromXmlCommand Object


Description:

Loads an XML configuration file into memory. This XML configuration file might create objects in memory. Call stc::apply to send the configuration to the connected chassis.

You can create an XML configuration file with the SaveAsXmlCommand object, or with the Spirent TestCenter GUI. In the GUI, choose File / Save As, and then set Save as type to Xml files (*.xml).

Can be used with Command Sequencer: No

Parents: Sequencer, StcSystem

LoadFromXmlCommand Writable Attributes

Attribute Description
Common Writable Attributes Active, Name, ProgressCancelled
FileName

File name of the XML configuration file to load. You can include a path. If you use the InputConfigString attribute, make this attribute empty.

Type: inputFilePath

Default: config.xml

InputConfigString

If the FileName attribute is empty, you can use an XML configuration as a string in this attribute.

Type: string

Default: 0

ParentConfig

Handle of the object under which to load the objects in the XML configuration. Do not use this if you want to replace the entire configuration. If you want to replace a single object, use the TargetConfig attribute and leave this at the default.

Type: handle

Default: 0

TargetConfig

Handle of the object to replace with the object that is in the XML configuration. Do not use this if you want to replace the entire configuration. If you want to replace the objects under a parent object, use the ParentConfig attribute and leave this at the default.

Type: handle

Default: 0

UseDefaultName

Whether to use the system-assigned names for each object that is loaded.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Use the system-assigned names for each object loaded.

FALSE

Use the names from the XML configuration, which may conflict with the already-assigned names.

LoadFromXmlCommand Read-Only Attributes

Read-Only Attribute Description
Common Read-Only Attributes ElapsedTime, EndTime, ProgressCurrentStep, ProgressCurrentStepName, ProgressCurrentValue, ProgressDisplayCounter, ProgressMaxValue, ProgressStepsCount, StartTime, State, Status
Config

Handle of the parent object of all the objects loaded.

Type: handle

Default: 0