StauffConsulting.Essentials.

StringSwitch

C#:  
public class StringSwitch :
    StauffConsulting.Essentials.Switch

VB:  
Public Class StringSwitch
    Inherits StauffConsulting.Essentials.Switch

Type Ancestry:  Object
+---Switch
+---+---StringSwitch

A switch that takes a single string value.

Summary Info

Constructor Summary

StringSwitch Constructor.

Field Summary

string Value The value that was passed to the switch on the command line.

Inherited from StauffConsulting.Essentials.Switch:
_help, AllSwitches, Found, Name, NameLC, Required, ValueHelp

Property Summary

Inherited from StauffConsulting.Essentials.Switch:
Help

Method Summary

Parse Tries to parse the next thing from the argument list. This is for internal use only by CmdLineParser.

Inherited from StauffConsulting.Essentials.Switch:
Parse, WriteHelp

Miscellany Summary

Constructor Details

StringSwitch

C#:  
StringSwitch (string name,
    string defaultValue,
    bool required,
    string help)

VB:  
Sub New(ByVal name As String, ByVal defaultValue As String, ByVal required As Boolean, ByVal help As String)

Constructor.

Parameters

name   the name of the switch; if it doesn't start with a hyphen. one is prepended.
defaultValue   the default value
required   is this parameter required?
help   a description of the switch.

Field Details

Value

C#:  
string Value;

VB:  
Value As String

The value that was passed to the switch on the command line.

Method Details

Parse

C#:  
Void Parse(StauffConsulting.Essentials.CmdLineParser p,
    System.Collections.ArrayList argList)

VB:  
Function Parse(ByVal p As StauffConsulting.Essentials.CmdLineParser, ByVal argList As System.Collections.ArrayList) As Void

(Inherited documentation)
Tries to parse the next thing from the argument list. This is for internal use only by CmdLineParser.

Parameters

p  
argList  

generated by DocGenDotNet on 18 Nov 2008 6:35:01 PM