MercurialPreCommandHook Class

Summary

This MercurialControllingHookBase descendant implements the code necessary to handle the "pre-command" hook: This is run before the command itself has started executing.
Assembly
Mercurial.Net.dll
Namespace
Mercurial.Hooks
Interfaces
Base Types
graph TD Base0["MercurialControllingHookBase"]-->Type click Base0 "/Cake.Hg/api/Mercurial.Hooks/MercurialControllingHookBase" Base1["MercurialHookBase"]-->Base0 click Base1 "/Cake.Hg/api/Mercurial.Hooks/MercurialHookBase" Base2["object"]-->Base1 Interface0["IMercurialControllingHook"]-.->Type click Interface0 "/Cake.Hg/api/Mercurial.Hooks/IMercurialControllingHook" Type["MercurialPreCommandHook"] class Type type-node

Syntax

public class MercurialPreCommandHook : MercurialControllingHookBase, IMercurialControllingHook

Remarks

As with all controlling hooks (descendants of MercurialControllingHookBase), you can prevent the command from continuing, or let it continue, by calling TerminateHookAndCancelCommand(int) or TerminateHookAndProceed() respectively.

Constructors

Name Summary
MercurialPreCommandHook()

Properties

Name Value Summary
Arguments MercurialCommandHookArgumentsCollection
Gets the collection of arguments to the command.
Options MercurialCommandHookDictionary
Gets the collection of options to the command.
Patterns MercurialCommandHookPatternCollection
Gets the collection of patterns given to the command.
Repository Repository
Gets the Repository the hook is executing in.
Inherited from MercurialHookBase

Methods

Name Value Summary
LoadRevision(string) RevSpec
Loads a RevSpec from a hash specified by an environment variable.
Inherited from MercurialHookBase
static
TerminateHookAndCancelCommand() void
Terminates the hook and cancels the Mercurial command being executed, with an exit code of 1 and no message.
TerminateHookAndCancelCommand(int) void
Terminates the hook and cancels the Mercurial command being executed, with the specified exit code and no message.
TerminateHookAndCancelCommand(int, string) 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.