Collapse all Symbian^3 Product Developer Library

CCommandLineArguments Class Reference

class CCommandLineArguments : public CBase

Parses command line arguments.

The class provides functions to access the arguments that are supplied when a program is launched as a new process.

The program name is returned as argument 0. Other arguments are returned as arguments 1, 2 etc.

The Count() function indicates how many arguments there are, including the program name. Arguments may be quoted to contain blanks and quotes.

The command line arguments and process name occupy 256 characters each. In order to minimise the space used throughout the lifetime of a program, it is recommended that the program parse the arguments shortly after initialisation, save the argument values appropriately, and then destroy the CCommandLineArguments object.

The main use of this class is in parsing the arguments of WINC command-line utilities.

This class is not intended for user derivation

Inherits from

CCommandLineArguments
- CBase

Public Member Functions
	~CCommandLineArguments()
IMPORT_C TPtrC	Arg(TInt)
IMPORT_C TInt	Count()
IMPORT_C CCommandLineArguments *	NewL()
IMPORT_C CCommandLineArguments *	NewLC()

Private Member Functions
	CCommandLineArguments()
void	ConstructL()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
CArrayFixFlat< TPtrC > *	iArgs
HBufC *	iCommandLine
TFileName	iFileName

Constructor & Destructor Documentation

CCommandLineArguments()

CCommandLineArguments

(

)

[private]

~CCommandLineArguments()

IMPORT_C

~CCommandLineArguments

(

)

Frees resources prior to destruction.

Member Functions Documentation

Arg(TInt)

IMPORT_C TPtrC

Arg

(

TInt

aArg

)

const

Returns a non-modifiable pointer descriptor representing the specified command-line argument.

Arg(0) is the file name as specified on the command line. Arg(1), Arg(2) etc. are the arguments specified to the command.

The pointer descriptor is valid throughout the lifetime of the CCommandLineArguments object. If you wish to retain argument values after the CCommandLineArguments object is destroyed, you should copy the argument data into a different object.

Parameters

TInt aArg

The index of the desired argument. This number must be less than Count(). Specify 0 for the name used to invoke the process. Specify 1, 2 etc. for the arguments.

ConstructL()

void

ConstructL

(

)

[private]

Count()

IMPORT_C TInt

Count

(

)

const

Returns the number of command line arguments, including the program name.

NewL()

IMPORT_C CCommandLineArguments *

NewL

(

)

[static]

Allocates and constructs a command line arguments parser. The function leaves if there is insufficient memory.

NewLC()

IMPORT_C CCommandLineArguments *

NewLC

(

)

[static]

Allocates and constructs a command line arguments parser, putting the returned pointer onto the cleanup stack. The function leaves if there is insufficient memory.

Member Data Documentation

CArrayFixFlat< TPtrC > * iArgs

CArrayFixFlat< TPtrC > *

iArgs

[private]

HBufC * iCommandLine

HBufC *

iCommandLine

[private]

TFileName iFileName

TFileName

iFileName

[private]