OpenTAP 9.25
API Reference
Public Member Functions | List of all members
OpenTap.Cli.ICliAction Interface Reference

Plugin type that defines a sub command for the OpenTAP CLI (tap.exe). Deriving from this, and annotating the class and any public properties with CommandLineArgumentAttribute and UnnamedCommandLineArgument attributes will allow it to be called from the OpenTAP CLI. More...

Inheritance diagram for OpenTap.Cli.ICliAction:
OpenTap.ITapPlugin OpenTap.Cli.RunCliAction OpenTap.Package.GitVersionAction OpenTap.Package.PackageAction OpenTap.Package.VerifyPackageHashes OpenTap.Package.LockingPackageAction OpenTap.Package.PackageCreateAction OpenTap.Package.CacheAction OpenTap.Package.IsolatedPackageAction

Public Member Functions

int Execute (CancellationToken cancellationToken)
 The code to be executed by the action. More...
 

Detailed Description

Plugin type that defines a sub command for the OpenTAP CLI (tap.exe). Deriving from this, and annotating the class and any public properties with CommandLineArgumentAttribute and UnnamedCommandLineArgument attributes will allow it to be called from the OpenTAP CLI.

Member Function Documentation

◆ Execute()

int OpenTap.Cli.ICliAction.Execute ( CancellationToken  cancellationToken)

The code to be executed by the action.

Returns
Return 0 to indicate success. Otherwise return a custom errorcode that will be set as the exitcode from the CLI.

Implemented in OpenTap.Cli.RunCliAction, OpenTap.Package.GitVersionAction, OpenTap.Package.PackageAction, OpenTap.Package.PackageCreateAction, OpenTap.Package.IsolatedPackageAction, and OpenTap.Package.LockingPackageAction.

OpenTAP 9.25 API built Tue Aug 6 2024 07:49:25