MercurialControllingHookBase Class

Summary

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.
Assembly
Mercurial.Net.dll
Namespace
Mercurial.Hooks
Interfaces
Base Types
Derived Types
graph TD Base0["MercurialHookBase"]-->Type click Base0 "/Cake.Hg/api/Mercurial.Hooks/MercurialHookBase" Base1["object"]-->Base0 Interface0["IMercurialControllingHook"]-.->Type click Interface0 "/Cake.Hg/api/Mercurial.Hooks/IMercurialControllingHook" Type["MercurialControllingHookBase"] class Type type-node Type-->Derived0["MercurialPrePushKeyHook"] click Derived0 "/Cake.Hg/api/Mercurial.Hooks/MercurialPrePushKeyHook" Type-->Derived1["MercurialPreListKeysHook"] click Derived1 "/Cake.Hg/api/Mercurial.Hooks/MercurialPreListKeysHook" Type-->Derived2["MercurialPreChangegroupHook"] click Derived2 "/Cake.Hg/api/Mercurial.Hooks/MercurialPreChangegroupHook" Type-->Derived3["MercurialPreTagHook"] click Derived3 "/Cake.Hg/api/Mercurial.Hooks/MercurialPreTagHook" Type-->Derived4["MercurialPreTransactionChangegroupHook"] click Derived4 "/Cake.Hg/api/Mercurial.Hooks/MercurialPreTransactionChangegroupHook" Type-->Derived5["MercurialPreUpdateHook"] click Derived5 "/Cake.Hg/api/Mercurial.Hooks/MercurialPreUpdateHook" Type-->Derived6["MercurialPreCommitHook"] click Derived6 "/Cake.Hg/api/Mercurial.Hooks/MercurialPreCommitHook" Type-->Derived7["MercurialPreCommandHook"] click Derived7 "/Cake.Hg/api/Mercurial.Hooks/MercurialPreCommandHook" Type-->Derived8["MercurialPreOutgoingHook"] click Derived8 "/Cake.Hg/api/Mercurial.Hooks/MercurialPreOutgoingHook" Type-->Derived9["MercurialPostCommandHook"] click Derived9 "/Cake.Hg/api/Mercurial.Hooks/MercurialPostCommandHook" Type-->Derived10["MercurialPreTransactionCommitHook"] click Derived10 "/Cake.Hg/api/Mercurial.Hooks/MercurialPreTransactionCommitHook"

Syntax

public class MercurialControllingHookBase : MercurialHookBase, IMercurialControllingHook

Constructors

Name Summary
MercurialControllingHookBase()

Properties

Name Value Summary
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.