Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | Related Pages

Help Class Reference

Used to get help messages for each shell command. More...

List of all members.

Public Member Functions

 Help ()
string GetSummary (string helpEntry)
 Get summary information for a shell command.
string GetDetails (string helpEntry)
 Get detailed information for a shell command.

Private Member Functions

string GetElement (string helpEntry, string element)
 Finds the right help node and returns the content of one of the childnodes.

Private Attributes

XmlDocument xmlDoc = new XmlDocument()


Detailed Description

Used to get help messages for each shell command.


Constructor & Destructor Documentation

Help::Help  )  [inline]
 


Member Function Documentation

string Help::GetDetails string  helpEntry  )  [inline]
 

Get detailed information for a shell command.

Exceptions:
ItemDoNotExsistsException If no detailed help message exsist for the command. That includes if the command do not exsist at all.

string Help::GetElement string  helpEntry,
string  element
[inline, private]
 

Finds the right help node and returns the content of one of the childnodes.

The search for the right node is case insensitive.

Parameters:
helpEntry Name of the help entry to find.
element The child node which content (InnerText) should be returned.

string Help::GetSummary string  helpEntry  )  [inline]
 

Get summary information for a shell command.

Exceptions:
ItemDoNotExsistsException If no summary help message exsist for the command. That includes if the command do not exsist at all.


Member Data Documentation

XmlDocument Help::xmlDoc = new XmlDocument() [private]
 


The documentation for this class was generated from the following file: SourceForge.net Logo