ObjectDCL Banner

ListBox_GetCount Method

Description

This method will return the total number of list items.

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.

Return Values

Returns the following according to the situation:

  • Integer indicating the number of items.
  • 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_GetCount 
		MyControlReference [as Reference]
	)

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_GetCount
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
	)

Applies For

DwgList, ListBox.

Example

CopyCode imageCopy Code
; Get the number of items
(setq rValue (Odcl_ListBox_GetCount MyProject_MyForm_MyControl))

See Also

ListBox_AddList, ListBox_AddString, ListBox_Clear, ListBox_DeleteString, ListBox_GetItemData, ListBox_InsertString, ListBox_SetItemData