CATCMDLINEARG Struct Reference

#include <CATCmdLine.h>

List of all members.

---

Detailed Description

CATCMDLINEARG is the entry format used for the table that must be created and passed to CATCmdLine::Initialize to enable it to parse a command line.

Each command entry is one of the following:

1. Operand - A command with no switch preceeding it.
2. Switch - A command that starts with a '/' or '-' and is proceeded by a single character. Multiple switches may follow a single '/' or '-' on the command line.
3. Switch w/Arg - A switch, like the above, but with an argument after it. The switch and argument must be seperated by a space.

Tables should begin with an operand for the executable itself, and end with an entry where CmdSwitch is -1.

Operands MUST have the following:

1. CmdSwitch must be 0
2. TakesArg must be false.
3. ArgOptDescId must be a short (single word) description of the operand.

If a switch takes and argument, ArgOptDescId should be valid. Otherwise it should be 0.

CmdGroup specifies a group of entries that are mutually exclusive. A CmdGroup of 0 indicates that the command is *not* part of a group. Any entries sharing the same CmdGroup value are in the same group.

Entries and CmdGroup IDs should be in order.

If a CmdGroup is required, set the Required flag on all entries. Otherwise, do not set the flag on *any* entries.

Definition at line 61 of file CATCmdLine.h.

Public Attributes
CATWChar	CmdSwitch
	0 indicates operand, -1 indicates end of table.
CATInt32	CmdGroup
	Specifies mutually exclusive cmd group.
CATBool	Required
	If true, the argument is required.
CATBool	TakesArg
	must be false for operands, otherwise true if switch takes arg
CATCMDFUNC	Callback
	optional callback function
CATUInt32	SwitchFlag
	optional flag to set for argument,
CATResult	ArgOptDescId
	ID of string for argument/operand description.
CATResult	DescriptionId
	ID of string for verbose description of operand/argument.

---

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

• CAT/CATCmdLine.h

---