ObjectDCL Banner

OptionList_GetCount Method

Description

This method will return the total number of options.

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 specifying the number of options.
  • Nil if the control is not found or is not visible.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_OptionList_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_OptionList_GetCount
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String])

Applies For

OptionList.

Example

CopyCode imageCopy Code
; Get the number of options
(Setq rValue (Odcl_OptionList_GetCount MyProject_MyForm_MyControl))

See Also

OptionList_AddList, OptionList_AddString, OptionList_Clear, OptionList_DeleteString, OptionList_InsertString