MFileManObserver Class Reference

Provides notification of the progress of synchronous or asynchronous file management operations. More...

#include <f32file.h>

Public Types
enum	TControl { EContinue , ERetry , EAbort , ECancel }
	Control for the current CFileMan operation. More...

Public Member Functions
virtual IMPORT_C TControl	NotifyFileManStarted ()
	Inform the observer that an operation is about to start.
virtual IMPORT_C TControl	NotifyFileManOperation ()
	Informs the observer that an operation, i.e.
virtual IMPORT_C TControl	NotifyFileManEnded ()
	Informs the observer that an operation is complete.

Detailed Description

Provides notification of the progress of synchronous or asynchronous file management operations.

It should be inherited by classes which implement this protocol.

The enquiry functions provided by CFileBase and CFileMan may be used by the observer to display information about the progress of the operation such as error messages, the names of the target and destination files, and the number of bytes transferred during a copy operation. Notification may take place before or after an entry has been processed, or during a file copy or move. Each notification function returns a value which can be used to enable the user to control the progress of the operation, for example to cancel a long-running multiple file copy. To use this class, pass a pointer to an instance of the class to the CFileMan constructor, or use SetObserver(), defined in CFileBase.

API status

Published to all clients. Released API.

Definition at line 2823 of file f32file.h.

Member Enumeration Documentation

TControl

enum MFileManObserver::TControl

Control for the current CFileMan operation.

Enumerator
EContinue	Proceed with the current or the next entry.
ERetry	Retry processing the previous entry.
EAbort	Abort operation, causes function to return KErrCancel.
ECancel	Cancel processing the current entry.

Definition at line 2852 of file f32file.h.

Member Function Documentation

NotifyFileManEnded()

IMPORT_C TControl MFileManObserver::NotifyFileManEnded ( )

virtual

Informs the observer that an operation is complete.

This is done immediately after a directory entry has been processed.

It may be useful to call CFileBase::GetLastError() and CFileBase::GetMoreInfoAboutError() from this function to retrieve information about how the operation ended.

CFileBase

(generated from Symbian Developer Library)

NotifyFileManOperation()

IMPORT_C TControl MFileManObserver::NotifyFileManOperation ( )

virtual

Informs the observer that an operation, i.e.

a copy or a move, is proceeding.

Large files are copied and moved in stages. After each portion of the source file has been copied to the target, this function is called.

It may be useful to call CFileMan::BytesTransferredByCopyStep() from this function to retrieve the current status of the operation.

MFileManObserver::EContinue, to continue with the operation. The default return value is MFileManObserver::EContinue.

CFileMan

(generated from Symbian Developer Library)

NotifyFileManStarted()

IMPORT_C TControl MFileManObserver::NotifyFileManStarted ( )

virtual

Inform the observer that an operation is about to start.

This is done immediately before each entry is processed.

(generated from Symbian Developer Library)

---

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

• f32file.h
• f32file.h.dox