OpenSim.Framework.ICommands Interface Reference

Inheritance diagram for OpenSim.Framework.ICommands:

Public Member Functions
void	FromXml (XmlElement root, CommandDelegate fn)
List< string >	GetHelp (string[] cmd)
	Get help for the given help string More...
void	AddCommand (string module, bool shared, string command, string help, string longhelp, CommandDelegate fn)
	Add a command to those which can be invoked from the console. More...
void	AddCommand (string module, bool shared, string command, string help, string longhelp, string descriptivehelp, CommandDelegate fn)
	Add a command to those which can be invoked from the console. More...
bool	HasCommand (string command)
	Has the given command already been registered? More...
string[]	FindNextOption (string[] command, bool term)
string[]	Resolve (string[] command)
XmlElement	GetXml (XmlDocument doc)

Detailed Description

Definition at line 36 of file ICommandConsole.cs.

Member Function Documentation

void OpenSim.Framework.ICommands.AddCommand	(	string	module,
		bool	shared,
		string	command,
		string	help,
		string	longhelp,
		CommandDelegate	fn
	)

Add a command to those which can be invoked from the console.

Parameters

module
command
help
longhelp
fn

Implemented in OpenSim.Framework.Console.Commands, and OpenSim.Framework.Console.MockCommands.

void OpenSim.Framework.ICommands.AddCommand	(	string	module,
		bool	shared,
		string	command,
		string	help,
		string	longhelp,
		string	descriptivehelp,
		CommandDelegate	fn
	)

Add a command to those which can be invoked from the console.

Parameters

module
command
help
longhelp
descriptivehelp
fn

Implemented in OpenSim.Framework.Console.Commands, and OpenSim.Framework.Console.MockCommands.

string [] OpenSim.Framework.ICommands.FindNextOption	(	string[]	command,
		bool	term
	)

Implemented in OpenSim.Framework.Console.Commands, and OpenSim.Framework.Console.MockCommands.

void OpenSim.Framework.ICommands.FromXml	(	XmlElement	root,
		CommandDelegate	fn
	)

Implemented in OpenSim.Framework.Console.Commands, and OpenSim.Framework.Console.MockCommands.

List<string> OpenSim.Framework.ICommands.GetHelp

(

string[]

cmd

)

Get help for the given help string

Parameters

cmd	Parsed parts of the help string. If empty then general help is returned.

Returns

Implemented in OpenSim.Framework.Console.Commands, and OpenSim.Framework.Console.MockCommands.

XmlElement OpenSim.Framework.ICommands.GetXml

(

XmlDocument

doc

)

Implemented in OpenSim.Framework.Console.Commands, and OpenSim.Framework.Console.MockCommands.

bool OpenSim.Framework.ICommands.HasCommand

(

string

command

)

Has the given command already been registered?

Returns

Parameters

command

Command.

Implemented in OpenSim.Framework.Console.Commands, and OpenSim.Framework.Console.MockCommands.

string [] OpenSim.Framework.ICommands.Resolve

(

string[]

command

)

Implemented in OpenSim.Framework.Console.Commands, and OpenSim.Framework.Console.MockCommands.

---

The documentation for this interface was generated from the following file:

• Framework/ICommandConsole.cs