GetBaseClass.AddOptionInteger Method (String, OptionInteger, String)

GetBaseClassAddOptionInteger Method (String, OptionInteger, String)

Adds a command line option to get integers and automatically save the value.

Namespace:  Rhino.Input.Custom
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
public int AddOptionInteger(
	string englishName,
	ref OptionInteger intValue,
	string prompt
)
Public Function AddOptionInteger ( 
	englishName As String,
	ByRef intValue As OptionInteger,
	prompt As String
) As Integer

Parameters

englishName
Type: SystemString
Must only consist of letters and numbers (no characters list periods, spaces, or dashes)
intValue
Type: Rhino.Input.CustomOptionInteger
The current integer value.
prompt
Type: SystemString
option prompt shown if the user selects this option. If null or empty, then the option name is used as the get number prompt.

Return Value

Type: Int32
option index value (>0) or 0 if option cannot be added.
Version Information

Rhino for Mac

Supported in: 5.4

Rhino for Windows

Supported in: 6.8
See Also