ListBox_GetItemData Method
Description
This method will retrieve the associated item data for the indicated list item.
Parameters
- MyControlReference
- Reference to the control in the form of MyProject_MyForm_MyControl.
- ProjectFile
- String identifying the project as it was passed in LoadProject.
- DialogName
- String identifying the dialog by name.
- ControlName
- String identifying the control by name.
- nItemIndex
- Integer specifying row index.
Return Values
Returns the following according to the situation:
- Integer indicating the user-defined data.
- Nil if the control is not found, does not support this function or if there is no such item.
AutoLISP Syntax
The recommended convention is passing the control identifier directly:
 Copy Code |
|---|
(Odcl_ListBox_GetItemData MyControlReference [as Reference] nItemIndex [as Integer]) |
An alternative convention is to identify the control by providing the project file, the dialog name and the control name:
| Copy Code |
|---|
(Odcl_ListBox_GetItemData ProjectFile [as String] DialogName [as String] ControlName [as String] nItemIndex [as Integer]) |
Applies For
Example
| Copy Code |
|---|
; Get the user-defined data of the 4th item (setq rValue (Odcl_ListBox_GetItemData MyProject_MyForm_MyControl 3)) |
See Also
ListBox_AddList, ListBox_AddString, ListBox_Clear, ListBox_DeleteString, ListBox_GetCount, ListBox_InsertString, ListBox_SetItemData