Teledyne LeCroy Verification Script Engine (VSE) Manual - Manual (Page 57)

Teledyne LeCroy Verification Script Engine Reference Manual
Page 57 of 115
9 Packet and Script Decoded Fields Retrieving Functions
This group of functions covers VSE generic capability to extract information about data payload fields decoded
with CATC Script Language (CSL) at Transfer level and all decoded fields at Packet level for USB3 packets.
9.1 GetDecodedPktField()
Extracts information about a USB3 packet field and determines how it is shown in the USB Protocol Suite
trace view or the "
View … Fields" dialog.
Format :
GetDecodedPktField ( fld_name )
Parameters
fld_name Name of the field supposedly existing in the current packet
Return Values
If the field name is in the current packet, the return value is the text value of the decoded field and how to display
it in the trace view. Otherwise, the return value is the empty string.
Example
if( in.TraceEvent == _USB3_LMP_PKT )
{
# Example of using decoded packet information for LMPs.
# ‘SubType’ field
# String value
str = FormatEx("\tSubType(str) = ‘%s’", GetDecodedPktField("SubType"));
ReportText( str );
}
Remark
The field name should be exactly the same as it is in the trace. The field name is case sensitive.