Access Routines

Top  Previous  Next

These routines allow your plug-in to return field information to the application.  They control all framing and formatting of the data.

 

Parameters

The access routines all share the following parameters:

TIMESTAMP:

This is the time at which the field starts or stops.  Note that timestamps must never be less than the previous timestamp.  They are allowed to match the previous timestamp in special cases.  See the section 'Debug Tips/Common Errors/Field Chronology' and 'Development hints/Zero Length Fields' below.

DATA:

You can supply up to 48 bits of data.  This data is interpreted by the Field Format for formatting and display.  Usually, the data is simply displayed as a single number.  However, the Field Format can extract slices (bit ranges) of the data to display multiple numbers in a field.  It can also specify slices to be used as indexes into lookup tables to print data driven text strings. How the bits are used is defined entirely by the Field Formats you specify (see Field Format Syntax below.)

FormatID:

FormatID is an index into the field format list you supplied in the GetStr call. See 'FIELD FORMATS' in 'GetStrLists' for details.

CntlCode:

This is a constant (defined in plug-in.h) defining which control code you wish to send

CNTLHALT

Halts the current Autorun sequence, making the current capture data the final capture.

CNTLSAVE

Forces this capture to be saved to disk (even if vetoed by other signals or autosearches.)

CNTLNOSAVE

Vetoes saving this capture to disk. 

void StartField(int64 timestamp, Data64 data, unsigned char FormatID)

This starts a new field at 'timestamp'. It auto-terminates any previous field. 
'Data' is interpreted and formatted per the field format specified by 'FormatID'

void StartFrame(int64 timestamp, Data64 data, unsigned char FormatID)

This starts a new field and tags it as a start of frame. It auto-terminates any previous field or frame. 
'Data' is interpreted and formatted per the field format specified by 'FormatID'

void EndField(int64 timestamp)

This marks the end of a field.  Timestamp is the ending time. This is optional.  Fields are auto-terminated by the next StartField or StartFrame.  The only reason to use this is if you want to see the field terminated earlier.

void EndFrame(int64 timestamp)

This marks the end of a frame.  Timestamp is the ending time.  This is optional.  Frames are auto-terminated by the next StartFrame.  The only reason to use this is if you want to see the frame terminated earlier.