CPosLmCatNameCriteria Class Reference

API published in: S60 3rd Ed

Link against: eposlmsearchlib.lib eposlmmultidbsearch.lib

Capability Information

Required Capabilities

None

Exceptions

The capability ReadUserData is required in:

CPosLandmarkSearch::StartLandmarkSearchL( const CPosLmSearchCriteria & aCriteria, TBool aSearchOnlyPreviousMatches = EFalse );

CPosLandmarkSearch::StartLandmarkSearchL( const CPosLmSearchCriteria & aCriteria, const TPosLmSortPref & aSortPref, TBool aSearchOnlyPreviousMatches = EFalse );

CPosLandmarkSearch::StartCategorySearchL( const CPosLmSearchCriteria & aCriteria, CPosLmCategoryManager::TCategorySortPref aSortPref, TBool aSearchOnlyPreviousMatches = EFalse );

CPosLmMultiDbSearch::StartLandmarkSearchL( const CPosLmSearchCriteria & aCriteria, TBool aSearchOnlyPreviousMatches = EFalse );

CPosLmMultiDbSearch::StartLandmarkSearchL( const CPosLmSearchCriteria & aCriteria, const TPosLmSortPref & aSortPref, TBool aSearchOnlyPreviousMatches = EFalse );

CPosLmMultiDbSearch::StartCategorySearchL( const CPosLmSearchCriteria & aCriteria, CPosLmCategoryManager::TCategorySortPref aSortPref, TBool aSearchOnlyPreviousMatches = EFalse );

Other Information

The capability NetworkServices is required to work with remote databases.


#include <epos_cposlmcatnamecriteria.h>

Inherits 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.


Public Member Functions

virtual  ~CPosLmCatNameCriteria ()
  Destructor.
IMPORT_C TPtrC  SearchPattern () const
  Retrieves the search pattern.
IMPORT_C void  SetSearchPatternL (const TDesC &aSearchPattern)
  Sets the search pattern.

Static Public Member Functions

static IMPORT_C CPosLmCatNameCriteria NewLC ()
  Two-phased constructor.

Constructor & Destructor Documentation

virtual CPosLmCatNameCriteria::~CPosLmCatNameCriteria  )  [virtual]
 

Destructor.


Member Function Documentation

static IMPORT_C CPosLmCatNameCriteria* CPosLmCatNameCriteria::NewLC  )  [static]
 

Two-phased constructor.

Returns:
A new instance of this class.
IMPORT_C TPtrC CPosLmCatNameCriteria::SearchPattern  )  const
 

Retrieves the search pattern.

Returns:
The category name search pattern.
IMPORT_C void CPosLmCatNameCriteria::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.

Parameters:
[in]  aSearchPattern  The pattern used to find categories.
Leave:
KErrArgument The search pattern is longer than KPosLmMaxCategoryNameLength.

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

Copyright © Nokia Corporation 2001-2008
Back to top