C# Class Mercurial.Hooks.MercurialControllingHookBase

This is the base class for Mercurial hook type implementations that are of type "controlling", that is that they can determine whether the Mercurial command being executed is allowed to proceed or not.
Inheritance: MercurialHookBase, IMercurialControllingHook
Mostrar archivo Open project: TargetProcess/Target-Process-Plugins

Public Methods

Method Description
TerminateHookAndCancelCommand ( ) : void

Terminates the hook and cancels the Mercurial command being executed, with an exit code of 1 and no message.

TerminateHookAndCancelCommand ( int exitCode ) : void

Terminates the hook and cancels the Mercurial command being executed, with the specified exit code and no message.

TerminateHookAndCancelCommand ( int exitCode, string message ) : void

Terminates the hook and cancels the Mercurial command being executed.

TerminateHookAndProceed ( ) : void

Terminates the hook program and allows the Mercurial command being hooked to proceed as normal.

Method Details

TerminateHookAndCancelCommand() public method

Terminates the hook and cancels the Mercurial command being executed, with an exit code of 1 and no message.
public TerminateHookAndCancelCommand ( ) : void
return void

TerminateHookAndCancelCommand() public method

Terminates the hook and cancels the Mercurial command being executed, with the specified exit code and no message.
/// must be 1 or higher. ///
public TerminateHookAndCancelCommand ( int exitCode ) : void
exitCode int /// The exit code to pass back to Mercurial, must be or higher to signal failure. Default is 1. ///
return void

TerminateHookAndCancelCommand() public method

Terminates the hook and cancels the Mercurial command being executed.
/// must be 1 or higher. /// /// is null. ///
public TerminateHookAndCancelCommand ( int exitCode, string message ) : void
exitCode int /// The exit code to pass back to Mercurial, must be or higher to signal failure. Default is 1. ///
message string /// A message to output to the Mercurial console log; or an empty string if no such message is needed. ///
return void

TerminateHookAndProceed() public method

Terminates the hook program and allows the Mercurial command being hooked to proceed as normal.
public TerminateHookAndProceed ( ) : void
return void