StauffConsulting.Essentials.

AppExitCode

C#:

public class AppExitCode :
    object

VB:

Public Class AppExitCode
    Inherits Object

Type Ancestry: Object +---AppExitCode

An exit code for an application (usually a console app).

Summary Info

Constructor Summary

AppExitCode constructor

Field Summary

`static readonly`	`AppExitCode>`	`AllExitCodes`	A list of all the exit code objects that have been instantiated
`readonly`	`string`	`Description`	A description of the exit code
`readonly`	`bool`	`IsError`	Indicates whether the exit code indicates an error
`readonly`	`int`	`Value`	The integer value for the exit code; what gets returned by the application

Property Summary

Method Summary

`DisplayAndReturn`	Displays this error code's description, exits the application, and returns this error code
`Return`	Exits the application and returns this error code

Miscellany Summary

Constructor Details

AppExitCode

C#:
AppExitCode (int value, bool isError, string description)

VB:
Sub New(ByVal value As Integer, ByVal isError As Boolean, ByVal description As String)

constructor

Parameters

value
isError
description

Field Details

AllExitCodes

C#:
readonly static System.Collections.Generic.SortedList AllExitCodes;

VB:
ReadOnly Shared AllExitCodes As System.Collections.Generic.SortedList(Of Integer, StauffConsulting.Essentials.AppExitCode)

A list of all the exit code objects that have been instantiated.

Description

C#:
readonly string Description;

VB:
ReadOnly Description As String

A description of the exit code.

IsError

C#:
readonly bool IsError;

VB:
ReadOnly IsError As Boolean

Indicates whether the exit code indicates an error.

Value

C#:
readonly int Value;

VB:
ReadOnly Value As Integer

The integer value for the exit code; what gets returned by the application.

Method Details

DisplayAndReturn

C#:
Void DisplayAndReturn()

VB:
Function DisplayAndReturn() As Void

Displays this error code's description, exits the application, and returns this error code.

Return

C#:
Void Return()

VB:
Function [Return]() As Void

Exits the application and returns this error code.

generated by DocGenDotNet on 18 Nov 2008 6:35:01 PM