Skip to content

Struct WshShellOption_t

ClassList > WshShellOption_t

Represents a shell command-line option. More...

  • #include <wsh_shell_option.h>

Public Attributes

Type Name
WshShell_Size_t Access
WshShell_Size_t ArgNum
const WshShell_Char_t * Descr
WshShell_Size_t ID
const WshShell_Char_t * LongName
const WshShell_Char_t * ShortName
WSH_SHELL_OPTION_TYPE_t Type

Detailed Description

This structure describes a single command-line option used in a shell command. It contains type, access level, required arguments, and optional short/long flags and description.

Public Attributes Documentation

variable Access

WshShell_Size_t WshShellOption_t::Access;

Access level required to use this option.


variable ArgNum

WshShell_Size_t WshShellOption_t::ArgNum;

Number of arguments expected by this option.


variable Descr

const WshShell_Char_t* WshShellOption_t::Descr;

Optional help description.


variable ID

WshShell_Size_t WshShellOption_t::ID;

Option identifier (for internal use).


variable LongName

const WshShell_Char_t* WshShellOption_t::LongName;

Long flag (e.g. "--verbose")


variable ShortName

const WshShell_Char_t* WshShellOption_t::ShortName;

Short flag (e.g. "-v")


variable Type

WSH_SHELL_OPTION_TYPE_t WshShellOption_t::Type;

Option type.



The documentation for this class was generated from the following file src/wsh_shell_option.h