clikt-core/com.github.ajalt.clikt.core/PrintHelpMessage

PrintHelpMessage

class PrintHelpMessage(var context: Context?, val error: Boolean = false, val statusCode: Int = 0) : CliktError, ContextCliktError

An exception that indicates that the command's help should be printed.

Execution should be immediately halted.

Constructors

PrintHelpMessage

constructor(context: Context?, error: Boolean = false, statusCode: Int = 0)

Properties

open val cause: Throwable?

open override var context: Context?

The context of the command that raised this error.

val error: Boolean = false

If true, the error message should be printed to stderr.

open val message: String?

val printError: Boolean = true

If true, the error message should be printed to stderr.

val statusCode: Int = 1

The value to use as the exit code for the process.