LineAPI.highlightSegment

 

long highlightSegment(string ck, int sIndex, bool flag)

This method changes the highlighting state of the segment associated sIndex for the track identified by the CARIS Key ck.  Highlighting is turned on or off, depending on whether flag is TRUE or FALSE, respectively.  It is not an error to attempt to turn on highlighting for a segment that is already highlighted, or to attempt to turn off highlighting for a segment that is not highlighted.  Such operations simply do nothing.

Valid values of sIndex 0 through n-1, where n is the number of segments in the track. The 0th segment is the one starting at the earliest track time. The (n-1)th segment is the one ending at the latest track time.

This method returns 0 upon success, and returns an error code if ck does not identify a track or sIndex is out of range.