Symbian^3 Application Developer Library >

TFSProgress Class Reference

class TFSProgress

Progress data structure to indicate different kind of progress information coming from plugins to user. Usually user uses progress events to update progress bar in user interface.

Download progress indication :

  • first event iProgressStatus = EFSStatus_Started

  • next event iProgressStatus = EFSStatus_Status

  • last event iProgressStatus = EFSStatus_RequestComplete

  • iMaxCount downloadable object total size

  • iCounter currently downloaded object size

  • iError KErrNone

Download request cancelled by user or by plugin :

  • iProgressStatus = EFSStatus_RequestCancelled

  • iMaxCount & iCounter optional, latest values or ignore/unknown = -1

  • iError = symbian error code KErrCancel

Download error :

  • iProgressStatus = EFSStatus_RequestCancelled

  • iMaxCount & iCounter optional, latest values or ignore/unknown = -1

  • iError symbian error code

Connection establisment progress :

  • iProgressStatus ; EFSStatus_Waiting, EFSStatus_Connecting, EFSStatus_Connected, EFSStatus_Authenticating, EFSStatus_Authenticated depending how plugin implements this

  • iMaxCount & iCounter optional, latest values or ignore/unknown = -1

  • iError symbian error code, KErrNone default

Public Member Enumerations
enum TFSProgressStatus {
EFSStatus_Waiting  = 1, EFSStatus_Started , EFSStatus_Connecting , EFSStatus_Connected , EFSStatus_Authenticating , EFSStatus_Authenticated , EFSStatus_Status , EFSStatus_RequestComplete , EFSStatus_RequestCancelled
}
Public Attributes
TInt iCounter
TInt iError
TInt iMaxCount
TFSProgressStatus iProgressStatus

Member Enumerations Documentation

Enum TFSProgressStatus

possible progress indication states

Enumerators

EFSStatus_Waiting = 1
EFSStatus_Started
EFSStatus_Connecting
EFSStatus_Connected
EFSStatus_Authenticating
EFSStatus_Authenticated
EFSStatus_Status
EFSStatus_RequestComplete
EFSStatus_RequestCancelled

Member Data Documentation

TInt iCounter

TInt iCounter

progress counter

TInt iError

TInt iError

error code (Symbian error codes)

TInt iMaxCount

TInt iMaxCount

max value in progress countingc

TFSProgressStatus iProgressStatus

TFSProgressStatus iProgressStatus

event progress / completion status

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.