Collapse all Symbian^3 Application Developer Library

RATExtCommon Class Reference

class RATExtCommon : public RSessionBase

Client side interface of ATEXT common functionality

atextcommon.lib

Since: S60 v5.0

Inherits from

RATExtCommon
- RSessionBase
  - RHandleBase

Public Member Functions
IMPORT_C TInt	CancelReceiveModeStatusChange ()
IMPORT_C TInt	CancelReceiveNvramStatusChange ()
IMPORT_C TInt	Connect (const TDesC8 &)
IMPORT_C TInt	GetMode ( TUint &, TUint &)
IMPORT_C TInt	GetNvramStatus ( TBuf8 < KDefaultNvramBufLength > &)
IMPORT_C TInt	ReceiveModeStatusChange ( TRequestStatus &, TPckg < TUint > &)
IMPORT_C TInt	ReceiveNvramStatusChange ( TRequestStatus &, TBuf8 < KDefaultNvramBufLength > &)
IMPORT_C TInt	SynchronousClose ()

Inherited Functions
	RHandleBase::Attributes()const
	RHandleBase::BTraceId()const
	RHandleBase::Close()
	RHandleBase::DoExtendedClose()
	RHandleBase::Duplicate(const RThread &,TOwnerType)
	RHandleBase::FullName()const
	RHandleBase::FullName(TDes &)const
	RHandleBase::Handle()const
	RHandleBase::HandleInfo(THandleInfo *)
	RHandleBase::Name()const
	RHandleBase::NotifyDestruction(TRequestStatus &)
	RHandleBase::Open(const TFindHandleBase &,TOwnerType)
	RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
	RHandleBase::RHandleBase()
	RHandleBase::RHandleBase(TInt)
	RHandleBase::SetHandle(TInt)
	RHandleBase::SetHandleNC(TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
	RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
	RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Open(TInt,TOwnerType)
	RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Send(TInt)const
	RSessionBase::Send(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt)const
	RSessionBase::SendReceive(TInt,TRequestStatus &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
	RSessionBase::SetReturnedHandle(TInt)
	RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
	RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
	RSessionBase::ShareAuto()
	RSessionBase::ShareProtected()

Inherited Enumerations
	RHandleBase:TAttributes
	RSessionBase:TAttachMode

Inherited Attributes
	RHandleBase::iHandle

Member Functions Documentation

CancelReceiveModeStatusChange()

IMPORT_C TInt

CancelReceiveModeStatusChange

(

)

Cancels a pending receiving request

Since: S60 5.0

CancelReceiveNvramStatusChange()

IMPORT_C TInt

CancelReceiveNvramStatusChange

(

)

Cancels a pending NVRAM receive request

Since: S60 5.0

Connect(const TDesC8 &)

IMPORT_C TInt

Connect

(

const TDesC8 &

aName

)

Connects to ATEXT server and creates a new session

Since: S60 5.0

Parameters

const TDesC8 & aName

Connection identifier name

GetMode(TUint &, TUint &)

IMPORT_C TInt	GetMode	(	TUint &	aMask,
			TUint &	aMode
		)

Gets current mode status

Since: S60 5.0

Parameters

TUint & aMask	Mask for current mode
TUint & aMode	Current mode (see explanation in atextcommonbase.h)

GetNvramStatus(TBuf8< KDefaultNvramBufLength > &)

IMPORT_C TInt

GetNvramStatus

(

TBuf8 < KDefaultNvramBufLength > &

aNvram

)

Gets current NVRAM status

Since: S60 5.0

Parameters

TBuf8 < KDefaultNvramBufLength > & aNvram

Current NVRAM status. The current settings (delimited by "|") must differ from the Hayes defaults.

ReceiveModeStatusChange(TRequestStatus &, TPckg< TUint > &)

IMPORT_C TInt	ReceiveModeStatusChange	(	TRequestStatus &	aStatus,
			TPckg < TUint > &	aMode
		)

Receives mode status change

Since: S60 5.0

Parameters

TRequestStatus & aStatus	The request status
TPckg < TUint > & aMode	Current mode (see explanation in atextcommonbase.h) This must be of type TPckgBuf<TUint>

ReceiveNvramStatusChange(TRequestStatus &, TBuf8< KDefaultNvramBufLength > &)

IMPORT_C TInt	ReceiveNvramStatusChange	(	TRequestStatus &	aStatus,
			TBuf8 < KDefaultNvramBufLength > &	aNvram
		)

Receives NVRAM status change

Since: S60 5.0

Parameters

TRequestStatus & aStatus	The request status
TBuf8 < KDefaultNvramBufLength > & aNvram	New NVRAM status. The new settings (delimited by "\|") must differ from the defaults.

SynchronousClose()

IMPORT_C TInt

SynchronousClose

(

)

Synchronously closes the session Optional: client can do either Close() or SynchronousClose() +Close()

Since: S60 v5.0