HelpText.AddOptions Method (Object, String, Int32)

HelpTextAddOptions Method (Object, String, Int32)

Adds a text block with options usage string.

Namespace: X3Platform.CommandLine.Text
Assembly: X3Platform.Support (in X3Platform.Support.dll) Version: 1.0.0.0 (2.0.0.0)

Syntax

public void AddOptions(
	Object options,
	string requiredWord,
	int maximumLength
)

public:
void AddOptions(
	Object^ options, 
	String^ requiredWord, 
	int maximumLength
)

options: Type: SystemObject
The instance that collected command line arguments parsed with the Parser class.
requiredWord: Type: SystemString
The word to use when the option is required.
maximumLength: Type: SystemInt32
The maximum length of the help documentation.

Exceptions

Exception	Condition
ArgumentNullException	Thrown when parameter options is null.
ArgumentNullException	Thrown when parameter requiredWord is null or empty string.