void setHighlightVertexMode(bool isSynchronous)
This method sets the state of the SDM such that a mouse click on a track highlights the vertex nearest the click.
The client using isSynchronous = TRUE must test for completion of the operation (as described in the discussion Synchronous vs. Asynchronous Response). When isSynchronousOpComplete returns TRUE, the client must call getKey, getItemIndex, and getItemState to obtain the CARIS Key, vertex index, and state, respectively, of the effected track vertex.
The client using isSynchronous = FALSE, must have previously identified itself to the MouseModeAPI object and exposed the method receiveHighlightedVertex (see Synchronous vs. Asynchronous Response), to which the track and vertex information is supplied as arguments.
Migration note for v2.5 developers: setHighlightVertexMode corresponds to setHighlightVertex when used asynchronously.