Function Reference


_GUICtrlListBox_GetCaretIndex

Return index of item that has the focus rectangle

#include <GuiListBox.au3>
_GUICtrlListBox_GetCaretIndex ( $hWnd )

Parameters

$hWnd Control ID/Handle to the control

Return Value

Success: the 0-based index of the selected item.
Failure: -1 if nothing is selected.

Related

_GUICtrlListBox_SetCaretIndex

Example

#include <GUIConstantsEx.au3>
#include <GuiListBox.au3>

Example()

Func Example()
    Local $iIndex, $idListBox

    ; Create GUI
    GUICreate("List Box Get Caret Index", 400, 296)
    $idListBox = GUICtrlCreateList("", 2, 2, 396, 296)

    GUISetState(@SW_SHOW)

    ; Add strings
    _GUICtrlListBox_BeginUpdate($idListBox)
    For $iI = 1 To 9
        _GUICtrlListBox_AddString($idListBox, StringFormat("%03d : Random string", Random(1, 100, 1)))
    Next
    _GUICtrlListBox_EndUpdate($idListBox)

    ; Set caret index
    _GUICtrlListBox_SetCaretIndex($idListBox, 2)

    ; Read caret index
    $iIndex = _GUICtrlListBox_GetCaretIndex($idListBox)
    _GUICtrlListBox_SetCurSel($idListBox, $iIndex)

    ; Loop until the user exits.
    Do
    Until GUIGetMsg() = $GUI_EVENT_CLOSE
    GUIDelete()
EndFunc   ;==>Example