LineAPI.highlightVertex

 

long highlightVertex(string ck, int vIndex, bool flag)

This method changes the highlighting state of the vertex associated vIndex 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 vertex that is already highlighted, or to attempt to turn off highlighting for a vertex that is not highlighted.  Such operations simply do nothing.

Valid values of vIndex are 0 through n-1, where n is the number of vertices in the track. The 0th vertex is the one at the earliest track time. The (n-1)th vertex is the one at the latest track time.

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