KeySetCursor

Cicode Programming Reference > Cicode Function Categories > Keyboard Functions Introduction > KeySetCursor

KeySetCursor

Displays the command cursor at a specified AN. A keyboard command needs to exist, or you need to first call the KeyAllowCursor() function (at the AN) to allow the cursor to move to the AN. If the AN does not exist, or if a command does not exist at that AN, or if KeyAllowCursor() has not been called, the command cursor does not move.

Syntax

KeySetCursor(AN)

AN:

The AN where the command cursor will be displayed.

Return Value

If the AN does not exist, or if a command does not exist at that AN, or if KeyAllowCursor() has not been called, the return value is 1. Otherwise, the function will return 0.

Related Functions

KeyGetCursor, KeyAllowCursor

Example

! Move the command cursor to AN20.

KeySetCursor(20);