CaptureDataSaveCommand Object


Description:

Save the captured data to a file.

Can be used with Command Sequencer: Yes

GUI Command Name: Basic: Save Capture Data

Parents: Sequencer, StcSystem

CaptureDataSaveCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
AppendSuffixToFileName

Whether to append a suffix to the saved capture file name.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Append suffix to saved capture file name.

FALSE

Do not append suffix to saved capture file name.

CaptureProxyId

Capture proxy ID (handle).

Type: handle

Default: 0

EndFrameIndex

End captured frame index to be viewed.

Type: u32

Default: 0

FileName

Name of the capture file.

Type: outputFilePath

Default: "" (empty string)

FileNameFormat

Format to use for the capture file.

Type: enum

Default: PCAP

Possible Values:

Value Description
PCAP

PCAP format, used by Wireshark and other packet sniffer applications.

FileNamePath

Path in which to save the capture file.

Type: string

Default: "" (empty string)

IsScap

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Instead of this attribute, use the FileNameFormat attribute.

Save the file in Spirent Capture file format.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Save file in Spirent Capture file format.

FALSE

Save file in PCAP format.

StartFrameIndex

Start captured frame index to be viewed.

Type: u32

Default: 0

CaptureDataSaveCommand Read-Only Attributes

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