ObjectDCL Banner

ListView_SetItemData Method

Description

This method will set the associated item data for the indicated list item. The item data will only accept integer values.

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.
nUserData
Integer specifying the user data.

Return Values

Returns the following according to the situation:

  • T when successful.
  • Nil if the control is not found, does not support this function or if there is no such row.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_ListView_SetItemData 
		MyControlReference [as Reference]
		nItemIndex [as Integer]
		nUserData [as Integer])

An alternative convention is to identify the control by providing the project file, the dialog name and the control name:

CopyCode imageCopy Code
(Odcl_ListView_SetItemData
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		nItemIndex [as Integer]
		nUserData [as Integer])

Applies For

ListView.

Example

CopyCode imageCopy Code
; Update the user-defined data of the fifth row
(Odcl_ListView_SetItemData MyProject_MyForm_MyControl 4 1024)

See Also

ListView_AddItem, ListView_AddItem (Report Style), ListView_Clear, ListView_CountItems, ListView_DeleteItem, ListView_DeleteItems, ListView_FillList, ListView_FillList (Report Style), ListView_GetCount, ListView_GetItemData, ListView_GetItemImage, ListView_GetItemText, ListView_GetRowItems, ListView_InsertItem, ListView_InsertItem (Report Style) ListView_SetItemImage, ListView_SetItemText