ScriptInfo Class

Contains information about a script that Inedo.Extensibility.Operations.IScriptingOperation can execute.

Inheritance Hierarchy

Syntax

public class ScriptInfo

Constructors

Name Description
ScriptInfo(System.Collections.Generic.IEnumerable<ScriptParameterInfo> parameters, string summary, System.Collections.Generic.IEnumerable<string> loadWarnings, string defaultArgumentsFormat, System.Collections.Generic.IEnumerable<ScriptConfigurationValues> configVariables, string ahExecModeVariable)
ScriptInfo(System.Exception loadError)

Initializes a new instance of the ScriptInfo class that indicates an inability to read or parse a script.

Properties

Name Description
ConfigValues

Gets any script configuration headers defined in the script.

DefaultArgumentsFormat

Gets a string that will be parsed as an OtterScript Inedo.ExecutionEngine.Variables.ProcessedString and evaluated to generate a command line argument string.

ExecModeVariable

Gets the name of the AhExecMode variable if used by the script.

FileName

Gets the file name (without directory and including the extension) of the script.

Language

Gets the ScriptLanguageInfo that was used to parse this instance.

LoadError

Gets the error which prevented the script from loading if applicable.

LoadWarnings

Gets messages to be logged as a warnings prior to running the script.

Parameters

Gets the expected input, output, environment, and arguments variables used by the script.

Summary

Gets the summary that will be displayed when the script is shown in a list.

Methods

Name Description
GetCommandLineInstructions(string arguments)

Returns a command line invocation of the script with the given arguments for display purposes.