OptionList_DeleteString Method
Description
This method will delete an option.
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 identifying an option to remove by its index.
Return Values
Returns the following according to the situation:
- T when successful.
- Nil if the control is not found, is not visible or there is option at the given index.
AutoLISP Syntax
The recommended convention is passing the control identifier directly:
 Copy Code |
|---|
(Odcl_OptionList_DeleteString MyControlReference [as Reference] nIndex [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_OptionList_DeleteString ProjectFile [as String] DialogName [as String] ControlName [as String] nIndex [as Integer]) |
Applies For
Example
| Copy Code |
|---|
; Remove the first option (Odcl_OptionList_DeleteString MyProject_MyForm_MyControl 0) |
See Also
OptionList_AddList, OptionList_AddString, OptionList_Clear, OptionList_GetCount, OptionList_InsertString