Enum SpectreConsoleHostedService.ExitCode

Defines exit codes for the SpectreConsoleHostedService application. These exit codes communicate the outcome of the application's execution to the calling process, allowing for scripted interactions and error handling.

Namespace: Coree.NETStandard.SpectreConsole
Assembly: Coree.NETStandard.dll
Syntax
public enum SpectreConsoleHostedService.ExitCode

Fields

Name Description
CommandFailedToRun

Indicates that the application command failed to run. This can occur if initialization fails or if the application is aborted before it can run properly.
CommandNotFound

Indicates that the specified command could not be found. This exit code is used when a user inputs a command that does not match any known command patterns.
CommandTerminated

Indicates that the command was terminated, often due to an external interrupt signal (e.g., Ctrl+C). This code is reserved for scenarios where the application's execution is abruptly stopped.
HelpVersionDisplayed

Indicates that help or version information was displayed. This neutral, Linux-like exit code is used when the application successfully displays help or version information upon request.
SuccessAndContinue

Indicates that the command executed successfully and the application will not initiate a shutdown. This exit code signifies that the command was completed successfully, and the application remains active for further commands or operations. The application lifecycle is not affected, and appLifetime.Stop is not called.

Note: If background services or other tasks running within the application encounter a failure, they need to set a failed exit code manually (e.g., `Environment.ExitCode = non-zero value`) before calling `appLifetime.Stop` to ensure the exit code accurately reflects the application state.
SuccessAndExit

Indicates that the command executed successfully and the application will initiate a shutdown. This exit code is used when a command completes successfully and dictates that the application should perform a clean shutdown by calling appLifetime.Stop. It signifies the end of the application's current lifecycle, allowing for graceful termination.

Extension Methods