hiGetCurrentIndex

hiGetCurrentIndex(
w_windowId 
) 
=> x_index / nil 

Description

Returns the current cursor index position relative to all the text in the window.

The related hiSetCurrentIndex SKILL command will respect document sizes, and also output a warning if the current index is set beyond the document limits.

Argument

w_windowId

Specifies the window ID.

Values Returned

x_index	The current cursor position.
nil	w_windowId is invalid. A warning is also issued.

Related Topics

Functions of Viewfile Window

hiSetCurrentIndex

Return to top