ObjectDCL Banner

ListBox_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.
nIndex
Integer specifying the index of the item.
nUserData
Integer specifying the user-defined data to associate.

Return Values

Returns the following according to the situation:

  • T when successful.
  • Nil if the control is not found or does not support this function.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_ListBox_SetItemData 
		MyControlReference [as Reference]
		nIndex [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_ListBox_SetItemData
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		nIndex [as Integer]
		nUserData [as Integer]
	)

Applies For

ListBox.

Example

CopyCode imageCopy Code
; Set the user-defined data of the second item
(Odcl_ListBox_SetItemData MyProject_MyForm_MyControl 1 8834766)

See Also

ListBox_AddList, ListBox_AddString, ListBox_Clear, ListBox_DeleteString, ListBox_GetCount, ListBox_GetItemData, ListBox_InsertString