ChocolateyAliases.

ChocolateyPin(ICakeContext, string, ChocolateyPinSettings) Method

Summary

Pins a Chocolatey package using the specified settings.

Syntax

[CakeMethodAlias]
[CakeAliasCategory("Pin")]
[CakeNamespaceImport("Cake.Common.Tools.Chocolatey.Pin")]
public static void ChocolateyPin(this ICakeContext context, string name, ChocolateyPinSettings settings)

Examples

ChocolateyPin("MyChocolateyPackage", new ChocolateyPinSettings {
    Version               = "1.2.3",
    Debug                 = false,
    Verbose               = false,
    Force                 = false,
    Noop                  = false,
    LimitOutput           = false,
    ExecutionTimeout      = 13,
    CacheLocation         = @"C:\temp",
    AllowUnofficial        = false
});

Attributes

Type Description
CakeMethodAliasAttribute An attribute used to mark script method aliases.
CakeAliasCategoryAttribute An attribute used for documentation of alias methods/properties.
CakeNamespaceImportAttribute An attribute used to hint Cake about additional namespaces that need to be imported for an alias to work. This attribute can mark an extension method, the extension method class, or the assembly to provide a global set of imports

Parameters

Name Type Description
context ICakeContext The context.
name string The name.
settings ChocolateyPinSettings The settings.

Return Value

Type Description
void