Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: APGCLI.H
Link against: apgrfx.lib

Class CDataRecognitionResultArray

class CDataRecognitionResultArray : public CBase;

Description

This class holds the recognition results of a recognized directory.

Derivation

Members

Defined in CDataRecognitionResultArray:
CDataRecognitionResultArray(), Count(), GetDataRecognitionResultL(), GetFileNameL(), Path(), ~CDataRecognitionResultArray()

Inherited from CBase:
Delete(), Extension_(), operator new()


Construction and destruction


CDataRecognitionResultArray()

IMPORT_C CDataRecognitionResultArray();

Description

Constructor


~CDataRecognitionResultArray()

virtual IMPORT_C ~CDataRecognitionResultArray();

Description

Destructor

[Top]


Member functions


Path()

IMPORT_C const TFileName &Path() const;

Description

Returns the path of the recognition results.

Return value

const TFileName &

The path of the recognition results


Count()

IMPORT_C TUint Count() const;

Description

Returns the number of entries in the CDataRecognitionResultArray.

Return value

TUint

The number of entries in the CDataRecognitionResultArray.


GetDataRecognitionResultL()

IMPORT_C void GetDataRecognitionResultL(TDataRecognitionResult &aResult, const TUint aIndex) const;

Description

Returns the recognition result of the given index.

Parameters

TDataRecognitionResult &aResult

On successful completion, this parameter contains the recognition result at the given index.

const TUint aIndex

The index of the recognition result to be returned. An invalid index causes the function to leave with KErrNotFound.

Leave codes

KErrNotFound

An invalid index is passed


GetFileNameL()

IMPORT_C void GetFileNameL(TFileName &aFileName, const TUint aIndex) const;

Description

Returns the file name of the object at the given index.

Parameters

TFileName &aFileName

On successful completion, this parameter contains the file name of the object at the given index.

const TUint aIndex

Specifies which file name to be returned. An invalid index causes the function to leave with KErrNotFound.

Leave codes

KErrNotFound

An invalid index is passed