Class TScheduledTaskFile

class TScheduledTaskFile;

Description

Class used by registered programs to access the scheduled task file store.

When tasks are due, the Task Scheduler encapsulates task information within CScheduledTask objects, and externalises them to a direct file store.

This file store is located in the task scheduler's private data cage and thus cannot be accessed directly. Instead the task scheduler passes a shared RFs and RFile handle to the registered program.

The registered program can use the RFile::AdoptFromCreator(TInt,TInt) API in conjunction with the APIs provided by this class to access the scheduled task file store as shown in the following example:

    RFile file;
    TInt error = file.AdoptFromCreator(TScheduledTaskFile::FsHandleIndex(),
                                            TScheduledTaskFile::FileHandleIndex());

Members

Defined in TScheduledTaskFile:

• FileHandleIndex()Returns the index of the slot in the process environment data that contains the ...
• FsHandleIndex()Returns the index of the slot in the process environment data that contains the ...

See also:

• CScheduledTaskThe representation of a scheduled task that is passed to registered programs.

IMPORT_C static TInt FsHandleIndex();

Description

Returns the index of the slot in the process environment data that contains the shared file server session (RFs) handle passed from the Task Scheduler.

Return value

TInt The index of the shared file server session handle

IMPORT_C static TInt FileHandleIndex();

Description

Returns the index of the slot in the process environment data that contains the shared file (RFile) handle passed from the Task Scheduler.

Return value

TInt The index of the shared file handle