MercurialPrePushKeyHook Class

Summary

This MercurialControllingHookBase descendant implements the code necessary to handle the "prepushkey" hook: This is run before a pushkey (like a bookmark) is added to the repository.
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["MercurialPrePushKeyHook"] class Type type-node

Syntax

public class MercurialPrePushKeyHook : 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
MercurialPrePushKeyHook()

Properties

Name Value Summary
Name string
Gets the name of the key that was pushed.
Namespace string
Gets the namespace the key was pushed to.
NewValue string
Gets the new value of the key.
OldValue string
Gets the old value of the key.
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.