Core::CmdLineSwitch Struct Reference

The definition of a command line switch. More...

#include <CmdLineSwitch.hpp>

List of all members.

Public Types
enum	Occurences { ONCE, MANY }
	The number of occurences. More...
enum	Parameters { NONE, SINGLE, MULTIPLE }
	The number of parameters. More...
Public Attributes
int	m_nID
	The identifier for the switch.
const tchar *	m_pszShortName
	The switch short name.
const tchar *	m_pszLongName
	The switch long name.
Occurences	m_eOccurences
	The number of ocurrences allowed.
Parameters	m_eParameters
	The number of addtional parameters.
const tchar *	m_pszParamDesc
	The parameter description.
const tchar *	m_pszDescription
	The switch description.

---

Detailed Description

The definition of a command line switch.

The CmdLineParser class uses a table of these to parse a command line. Each switch must have at least a short or long name.

---

Member Enumeration Documentation

enum Core::CmdLineSwitch::Occurences

The number of occurences.

Enumerator:

ONCE
MANY

enum Core::CmdLineSwitch::Parameters

The number of parameters.

Enumerator:

NONE
SINGLE
MULTIPLE

---

Member Data Documentation

int Core::CmdLineSwitch::m_nID

The identifier for the switch.

const tchar* Core::CmdLineSwitch::m_pszShortName

The switch short name.

const tchar* Core::CmdLineSwitch::m_pszLongName

The switch long name.

Occurences Core::CmdLineSwitch::m_eOccurences

The number of ocurrences allowed.

Parameters Core::CmdLineSwitch::m_eParameters

The number of addtional parameters.

const tchar* Core::CmdLineSwitch::m_pszParamDesc

The parameter description.

const tchar* Core::CmdLineSwitch::m_pszDescription

The switch description.

---

The documentation for this struct was generated from the following file:

• CmdLineSwitch.hpp