Symbian^3 Application Developer Library >

MXIMPStatus Class Reference

class MXIMPStatus : public MXIMPBase

Interface for status object.

Status object is used in XIMP Framework API to present result code and additional textual details from request completions, context state changes and similar events.

Since
S60 v3.2

Inherits from

Public Member Functions
~MXIMPStatus ()
TInt ProtocolResultCode ()
const TDesC16 & ProtocolResultDescription ()
TInt ResultCode ()
void SetProtocolResultCode ( TInt )
void SetProtocolResultDescriptionL (const TDesC16 &)
void SetResultCode ( TInt )
Inherited Functions
MXIMPBase::GetInterface(TInt32,TIfGetOps)
MXIMPBase::GetInterface(TInt32,TIfGetOps)const
MXIMPBase::GetInterfaceId()const
MXIMPBase::~MXIMPBase()
Inherited Enumerations
MXIMPBase:@26
MXIMPBase:TIfGetOps

Constructor & Destructor Documentation

~MXIMPStatus()

~MXIMPStatus ( ) [inline, virtual]

Public destructor. Objects can be deleted through this interface.

Member Functions Documentation

ProtocolResultCode()

TInt ProtocolResultCode ( ) const [pure virtual]

Gets the protocol level response code.

ProtocolResultDescription()

const TDesC16 & ProtocolResultDescription ( ) const [pure virtual]

Get the textual result description. Textual descriptions are protocol specific.

ResultCode()

TInt ResultCode ( ) const [pure virtual]

Gets request completion code.

Result code can be:

  • one of the system wide errors

  • one of the ximp core specific errors defined in in ximperrors.hrh

  • one of the presence specific errors defined in in presenceerrors.hrh

  • error specific to the underlying communication channel

SetProtocolResultCode(TInt)

void SetProtocolResultCode ( TInt aCode ) [pure virtual]

Sets textual result description.

Parameters

TInt aCode

SetProtocolResultDescriptionL(const TDesC16 &)

void SetProtocolResultDescriptionL ( const TDesC16 & aDescription ) [pure virtual]

Sets textual result description.

Parameters

const TDesC16 & aDescription The textual result description.

SetResultCode(TInt)

void SetResultCode ( TInt aCode ) [pure virtual]

Sets request completion code.

Parameters

TInt aCode The result code.

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.