CCommandLineArguments Class Reference

#include <bacline.h>

Link against: bafl.lib

class CCommandLineArguments : public CBase

Inherits from

  • CCommandLineArguments
    Public Member Functions
    ~CCommandLineArguments()
    IMPORT_C TPtrCArg(TInt)
    IMPORT_C TIntCount()
    IMPORT_C CCommandLineArguments *NewL()
    IMPORT_C CCommandLineArguments *NewLC()
    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()

    Detailed Description

    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

    Constructor & Destructor Documentation

    ~CCommandLineArguments ( )

    IMPORT_C~CCommandLineArguments()

    Frees resources prior to destruction.

    Member Function Documentation

    Arg ( TInt )

    IMPORT_C TPtrCArg(TIntaArg)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.

    ParameterDescription
    aArgThe 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.

    Returns: Non-modifiable pointer descriptor to the specified argument text.

    Count ( )

    IMPORT_C TIntCount()const

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

    Returns: The number of command line arguments, plus one for the program name. Returns 1, if no arguments are specified.

    NewL ( )

    IMPORT_C CCommandLineArguments *NewL()[static]

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

    Returns: The command line arguments parser.

    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.

    Returns: The command line arguments parser.

    © Nokia 2011.