CPosLmCatNameCriteria Class Reference

#include <mw/EPos_CPosLmCatNameCriteria.h>

Link against: eposlmsearchlib.lib

class CPosLmCatNameCriteria : public CPosLmSearchCriteria

Inherits from

CPosLmCatNameCriteria
- CPosLmSearchCriteria

Public Member Functions
virtual	~CPosLmCatNameCriteria()
IMPORT_C CPosLmCatNameCriteria *	NewLC()
IMPORT_C TPtrC	SearchPattern()
IMPORT_C void	SetSearchPatternL(const TDesC &)

Inherited Enumerations
	CPosLmSearchCriteria:TCriteriaType

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()
	CPosLmSearchCriteria::CPosLmSearchCriteria(TCriteriaType)
	CPosLmSearchCriteria::CriteriaType()const
	CPosLmSearchCriteria::~CPosLmSearchCriteria()

Detailed Description

Criterion for searching landmark categories with a certain name.

Wild-card characters are supported.

The client specifies the search pattern and starts the search using CPosLandmarkSearch . The search returns all categories which match the search pattern.

This criterion is only valid when searching for landmark categories, i.e. if it is passed to CPosLandmarkSearch::StartLandmarkSearchL, the function will fail with error code KErrArgument.

Since: S60 3.0

Constructor & Destructor Documentation

~CPosLmCatNameCriteria ( )

~CPosLmCatNameCriteria

(

)

[virtual]

Destructor.

Member Function Documentation

NewLC ( )

IMPORT_C CPosLmCatNameCriteria *

NewLC

(

)

[static]

Two-phased constructor.

Returns: A new instance of this class.

SearchPattern ( )

IMPORT_C TPtrC

SearchPattern

(

)

const

Retrieves the search pattern.

Returns: The category name search pattern.

SetSearchPatternL ( const TDesC & )

IMPORT_C void

SetSearchPatternL

(

const TDesC &

aSearchPattern

)

Sets the search pattern.

A non-empty search pattern must be set, otherwise CPosLandmarkSearch::StartCategorySearchL will leave with error code KErrArgument.

The search is case insensitive.

Wild-card characters "?" and "*" are supported in the search string. "?" matches a single occurrence of any character and "*" matches zero or more consecutive occurrences of any characters.

leave: KErrArgument The search pattern is longer than KPosLmMaxCategoryNameLength.

Parameter	Description
aSearchPattern	The pattern used to find categories.