CSyncMLFilter Class Reference

#include <SyncMLDataFilter.h>

Link against: syncmldatafilter.lib

class CSyncMLFilter : public CBase

Inherits from

CSyncMLFilter

Public Member Functions
	~CSyncMLFilter()
IMPORT_C TInt	DataSize()
IMPORT_C const TDesC &	DisplayDescription()
IMPORT_C const TDesC &	DisplayName()
IMPORT_C TBool	Enabled()
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C TUint	FilterId()
IMPORT_C RPointerArray< CSyncMLFilterProperty > &	FilterProperties()
IMPORT_C TBool	MatchTypeSupported()
IMPORT_C CSyncMLFilter *	NewLC()
IMPORT_C CSyncMLFilter *	NewLC(TResourceReader &)
IMPORT_C CSyncMLFilter *	NewLC(RReadStream &)
IMPORT_C void	SetEnabledL(const TBool)
IMPORT_C void	SetMatchTypeSupported(const TBool)
IMPORT_C void	SetSupportedByServerL(const TBool)
IMPORT_C TBool	SupportedByServer()

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

Filter Class.

Constructor & Destructor Documentation

~CSyncMLFilter ( )

IMPORT_C

~CSyncMLFilter

(

)

Destructor.

Member Function Documentation

DataSize ( )

IMPORT_C TInt

DataSize

(

)

Size of data

Returns: Size of internal data

DisplayDescription ( )

IMPORT_C const TDesC &

DisplayDescription

(

)

const

Description of filter.

Returns: TDesC Description of the filter.

DisplayName ( )

IMPORT_C const TDesC &

DisplayName

(

)

const

Name of filter.

Returns: TDesC Name of the filter.

Enabled ( )

IMPORT_C TBool

Enabled

(

)

const

Filter enable/disable information.

Returns: TBool ETrue if filter is enabled. Otherwise EFalse is returned.

ExternalizeL ( RWriteStream & )

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalizes filter.

Parameter	Description
aStream	Specifies stream where filter is externalized.

FilterId ( )

IMPORT_C TUint

FilterId

(

)

const

ID of filter.

Returns: TUint ID of the filter.

FilterProperties ( )

IMPORT_C RPointerArray< CSyncMLFilterProperty > &

FilterProperties

(

)

Properties of filter.

Returns: RPointerArray Properties of filter.

MatchTypeSupported ( )

IMPORT_C TBool

MatchTypeSupported

(

)

const

Information about match type effect to filter.

Returns: TBool ETrue if match type affect to filter. Otherwise EFalse is returned.

NewLC ( )

IMPORT_C CSyncMLFilter *

NewLC

(

)

[static]

Symbian two-phased constructor.

NewLC ( TResourceReader & )

IMPORT_C CSyncMLFilter *

NewLC

(

TResourceReader &

aReader

)

[static]

Symbian two-phased constructor.

Parameter	Description
aReader	TResourceReader for recource file that includes needed information to initialize filter.

NewLC ( RReadStream & )

IMPORT_C CSyncMLFilter *

NewLC

(

RReadStream &

aStream

)

[static]

Symbian two-phased constructor.

Parameter	Description
aStream	RReadStream for stream that includes needed information to initialize filter.

SetEnabledL ( const TBool )

IMPORT_C void

SetEnabledL

(

const TBool

aEnabled

)

Set filter enable/disable information.

Parameter	Description
aEnabled	ETrue if filter enabled and EFalse is filter is disabled

SetMatchTypeSupported ( const TBool )

IMPORT_C void

SetMatchTypeSupported

(

const TBool

aSupported

)

Set information about match type effect to filter.

Parameter	Description
aSupported	ETrue if match type affect to filter and EFalse if it does not affect.

SetSupportedByServerL ( const TBool )

IMPORT_C void

SetSupportedByServerL

(

const TBool

aSupported

)

Set information about server capabilities to support this filter.

Parameter	Description
aSupported	ETrue if filter is supported by server and EFalse if it is not supported.

SupportedByServer ( )

IMPORT_C TBool

SupportedByServer

(

)

const

Information about server capabilities to support this filter.

Returns: TBool ETrue if filter is supported by server. Otherwise EFalse is returned.