PeanutButter.ServiceShell.ServiceCommandlineOptions Class Reference

More...

Inheritance diagram for PeanutButter.ServiceShell.ServiceCommandlineOptions:

Public Types
enum	ExitCodes {   Success = 0 , CommandlineArgumentError , Failure , ShowedHelp ,   InstallFailed , UninstallFailed }
	Codes issued at exit. More...

Public Member Functions
	ServiceCommandlineOptions ()
	parameterless constructor to be used with something else that parses arguments, eg EasyArgs
	ServiceCommandlineOptions (string[] args, string helpHeading, string copyRightInformation=null)
	Construct the commandline arguments, using the string[] args provided to the program.

Properties
bool	Install [get, set]
	Instructs the service to install itself.
bool	Uninstall [get, set]
	Instructs the service to uninstall itself.
bool	RunOnce [get, set]
	Instructs the service to run one round of operations and then exit.
bool	Debug [get, set]
	Instructs the service to run continually, with logging set to ALL.
int	Wait [get, set]
	Instructs the service to wait this many seconds before actually doing a round of work for RunOnce.
bool	ShowVersion [get, set]
	Instructs the service to display its current version.
bool	StartService [get, set]
	Instructs the service to start itself, if it is registered.
bool	StopService [get, set]
	Instructs the service to stop itself, if it is registered.
bool	ManualStart [get, set]
	Instructs the service to install with manual startup, when invoked to install itself.
bool	Disabled [get, set]
	Instructs the service to install itself disabled, when invoked to install itself.

Detailed Description

Member Enumeration Documentation

ExitCodes

enum PeanutButter.ServiceShell.ServiceCommandlineOptions.ExitCodes

Codes issued at exit.

Enumerator
Success	Operation was successful (0)
CommandlineArgumentError	An invalid commandline was specified.
Failure	The requested operation (eg start/stop) could not be completed.
ShowedHelp	The service showed help and exited.
InstallFailed	Installation failed.
UninstallFailed	Uninstallation failed.

Constructor & Destructor Documentation

ServiceCommandlineOptions()

PeanutButter.ServiceShell.ServiceCommandlineOptions.ServiceCommandlineOptions	(	string[]	args,
		string	helpHeading,
		string	copyRightInformation = null )

Construct the commandline arguments, using the string[] args provided to the program.

Parameters

args
helpHeading
copyRightInformation

Property Documentation

Debug

bool PeanutButter.ServiceShell.ServiceCommandlineOptions.Debug

getset

Instructs the service to run continually, with logging set to ALL.

Implements PeanutButter.ServiceShell.IServiceCommandlineOptions.

Disabled

bool PeanutButter.ServiceShell.ServiceCommandlineOptions.Disabled

getset

Instructs the service to install itself disabled, when invoked to install itself.

Implements PeanutButter.ServiceShell.IServiceCommandlineOptions.

Install

bool PeanutButter.ServiceShell.ServiceCommandlineOptions.Install

getset

Instructs the service to install itself.

Implements PeanutButter.ServiceShell.IServiceCommandlineOptions.

ManualStart

bool PeanutButter.ServiceShell.ServiceCommandlineOptions.ManualStart

getset

Instructs the service to install with manual startup, when invoked to install itself.

Implements PeanutButter.ServiceShell.IServiceCommandlineOptions.

RunOnce

bool PeanutButter.ServiceShell.ServiceCommandlineOptions.RunOnce

getset

Instructs the service to run one round of operations and then exit.

Implements PeanutButter.ServiceShell.IServiceCommandlineOptions.

ShowVersion

bool PeanutButter.ServiceShell.ServiceCommandlineOptions.ShowVersion

getset

Instructs the service to display its current version.

Implements PeanutButter.ServiceShell.IServiceCommandlineOptions.

StartService

bool PeanutButter.ServiceShell.ServiceCommandlineOptions.StartService

getset

Instructs the service to start itself, if it is registered.

Implements PeanutButter.ServiceShell.IServiceCommandlineOptions.

StopService

bool PeanutButter.ServiceShell.ServiceCommandlineOptions.StopService

getset

Instructs the service to stop itself, if it is registered.

Implements PeanutButter.ServiceShell.IServiceCommandlineOptions.

Uninstall

bool PeanutButter.ServiceShell.ServiceCommandlineOptions.Uninstall

getset

Instructs the service to uninstall itself.

Implements PeanutButter.ServiceShell.IServiceCommandlineOptions.

Wait

int PeanutButter.ServiceShell.ServiceCommandlineOptions.Wait

getset

Instructs the service to wait this many seconds before actually doing a round of work for RunOnce.

Implements PeanutButter.ServiceShell.IServiceCommandlineOptions.

---

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

• source/Win32Service/PeanutButter.ServiceShell/ServiceCommandlineOptions.cs