ShellCommandGetShellCommandDescription Method

Gets the description of the specified shell command.

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 2.3.0

Syntax

public static string GetShellCommandDescription(
	Type commandType
)

Public Shared Function GetShellCommandDescription ( 
	commandType As Type
) As String

Dim commandType As Type
Dim returnValue As String

returnValue = ShellCommand.GetShellCommandDescription(commandType)

public:
static String^ GetShellCommandDescription(
	Type^ commandType
)

Parameters

commandType: Type: SystemType
The Type of the shell command.

Return Value

Type: String
The shell command's description, or if it doesn't specify one.

Exceptions

Exception	Condition
ArgumentNullException	commandType is .
ArgumentException	commandType is not a shell command type.

Remarks

A shell command's description is specified using the DescriptionAttribute attribute.

Reference

ShellCommand Class

Ookii.CommandLine Namespace

ShellCommandAddLanguageSpecificTextSet("LSTF9210D72_0?cpp=::|nu=.");GetShellCommandDescription Method

Parameters

Return Value

Reference

ShellCommandGetShellCommandDescription Method