Addevent() – Teledyne LeCroy FireInspector - File Based Decoding User Manual

Page 54

CATC S

CRIPTING

ANGUAGE

1.0

HAPTER

Reference Manual

Decoder Primitives

Example

# Creates a data cell with 2 dwords (32-bit integers)
of data.

AddDataCell( '0123456789ABCDEF', _DWORDS );

# Creates a data cell with 4 bytes. Integer data
values are always interpreted as 32 bits of data.

AddDataCell( 0x11223344, _BYTES );

The output of the example is:

AddEvent()

AddEvent(string>, string> )

Return value

None.

Comments

Events are used for transaction searching and for transaction summary. This
function is only effective when called during the

ProcessData()

phase of

decoding. Event groups and values are stored globally for transaction levels and
new ones are created as they are encountered. Each transaction contains informa-
tion as to which events were associated with it.

Example

AddEvent( "DataLength", Format( "%d",
out.DataLength ));

Figure 13-2: Example output for

AddDataCell

Parameter

Meaning

Default Value

Comments

Group string

The name of

the group

Corresponds to the name of a field that might be
encountered while decoding.

Value string

A value that

will be

associated

with the group

Corresponds to a field value that might be
encountered while parsing.