Interface IExternalCommandLineProcessor

Represents a command line processor extension, which is responsible for processing a number of command line arguments, which allow the user the execute a specific task or a set of tasks from the command line. This will be executed before the main window is created.

Namespace: Sdl.Desktop.IntegrationApi.Extensions.CommandLine
Assembly: Sdl.Desktop.IntegrationApi.Extensions.dll
Syntax
public interface IExternalCommandLineProcessor

Properties

SupportedArguments

Gets the definitions for the supported command line arguments for this processor.

Declaration
IEnumerable<ExternalCommandLineArgumentDefinition> SupportedArguments { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<ExternalCommandLineArgumentDefinition>

TaskDescription

Gets the description of the task or tasks which the processor allows the user to execute from the command line.

Declaration
string TaskDescription { get; }
Property Value
Type Description
System.String

TaskName

Gets the name of the task or tasks which the processor allows the user to execute from the command line.

Declaration
string TaskName { get; }
Property Value
Type Description
System.String

Methods

ProcessCommandLine(ExternalCommandLineArguments)

This methods is called when the processor is executed.

Declaration
void ProcessCommandLine(ExternalCommandLineArguments args)
Parameters
Type Name Description
ExternalCommandLineArguments args

The full set of command line arguments and values supplied by the user, not restricted to the arguments expected by this processor.
Remarks

A command line processor will always be executed, even if none of its expected parameters have been specified.

Extension Methods