hiGetCursorByName

hiGetCursorByName(
t_cursorName
) 
=> x_cursorID

Description

Returns the ID associated with the specified cursor name.

Arguments

t_cursorName

Name of a cursor. For example, the cursor name that is returned by the hiGetCursorName SKILL function.

Value Returned

x_cursorID

An integer that is the ID of the specified cursor name. If the cursor name is "unknown", 1 is returned, which is the value of hicArrow. If the name is invalid, 0 is returned, which is the value of hicNoCursor.

Examples

Using hiGetCursorName() to get the name of specified cursor ID.

hiGetGetCursorByName("arrow")

=> 1

; 1 is the value of hicArrow

hiGetCursorByName("ibeam")

=> 5

; 5 is the value of hicIbeam

hiGetCursorByName("unknown")

=> 1

; 1 is the value of hicArrow

hiGetCursorByName("invalidName")

=> 0

; 0 is the value of hicNoCursor

Related Topics

Window Functions

hiGetCursorName

Return to top