Click or drag to resize

GetBaseClassAddOptionString Method (String, OptionString, String)

Add a command line option to get a string and automatically save the value.

Namespace:  Rhino.Input.Custom
Assembly:  RhinoCommon (in RhinoCommon.dll)
Since: 9.0
Syntax
public int AddOptionString(
	string englishName,
	ref OptionString stringValue,
	string prompt
)

Parameters

englishName
Type: SystemString
The option description.
stringValue
Type: Rhino.Input.CustomOptionString
The current string value.
prompt
Type: SystemString
Command prompt to be shown if the picks this option.

Return Value

Type: Int32
The option index value (>0) or 0 if option cannot be added.
See Also