Class CEikProcess

class CEikProcess : public CApaProcess;

Description

The controlling process for an application.

An instance of this class is created by the Uikon environment. This instance calls CApaProcess::AddNewDocumentL(TApaApplicationFactory) to load the application DLL and construct the new application which runs in this environment.

It also provides services related to an application's main (non-embedded) document, including:

• saving the main document to a direct file store

• providing the name of the most recently accessed file

• getting the name of the application DLL associated with a document.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CApaProcess - Maintains a list of documents and all of the potentially shared resources used b...

• CEikProcess - The controlling process for an application.

Members

Defined in CEikProcess:

• AppFromDocL(TDes &,const TDesC &)constGets the name of the application DLL associated with the specified document.
• CommandTailEnd()constReturns the command tail end - i.e. command line parameters
• ELastCreatedFileLast created file.
• ELastOpenFileLast opened file.
• LastUsedFileL(TLastUsedFile)constGets the name of either the last opened or last created file.
• MainDocFolder()constReturns the drive and path of the main document.
• MainStore()constGets a pointer to the main store. This is the file store that holds the main doc...
• SaveToDirectFileStoreL(CEikDocument *,const TFileName *)Saves the main document optionally to a new file.
• SaveToDirectFileStoreL(CEikDocument *,const TFileName *,TBool,TFileName *)Saves the main document optionally to a new file, and optionally opens it.
• SetLastUsedFileL(TLastUsedFile,const TDesC &)constSets the name of either the last opened or the last created file.
• SetMainStore(CFileStore *)Sets the file store that stores the main document.
• TLastUsedFileUsed as a parameter by CEikProcess::SetLastUsedFileL(TLastUsedFile,const TDesC &...
• ~CEikProcess()Destructor.

Inherited from CApaProcess:

• AddNewDocumentL(TApaApplicationFactory)Creates and adds a new document using the specified application factory.
• CApaProcess(const RFs &)Constructs the application process object with the specified file session handle...
• CApaProcess_Reserved1()Reserved for future use
• CApaProcess_Reserved2()Reserved for future use
• ConstructL()Completes construction of the application process object.
• ConstructL(TProcessId)Completes construction of the application process object, passing in a Parent Pr...
• DestroyDocument(CApaDocument *)Destroys the specified document.
• FsSession()constReturns a handle to the file server session used by this application process.
• MainDocFileName()constReturns the filename of the main document.
• MainDocument()constReturns a pointer to the main document.
• NewL(const RFs &)Creates and returns a pointer to a new application process.
• OpenNewDocumentL(CFileStore *&,CStreamDictionary *&,const TDesC &,TUint)Opens the specified file and restores the content as a document.
• ReadAppIdentifierL(const CStreamStore &,const CStreamDictionary &)Reads the application identifier from its stream in the specified store and retu...
• ReadRootStreamLC(RFs &,CFileStore *&,const TDesC &,TUint)Reads the stream dictionary contained as the root stream in the specified docume...
• ResetL()Resets the the application process to its initial state.
• SetMainDocFileName(const TDesC &)Sets the filename of the main document.
• SetMainDocFileNameL(const TDesC &)Sets the filename of the main document.
• SetMainDocument(CApaDocument *)Sets the main document.
• WriteAppIdentifierL(CStreamStore &,CStreamDictionary &,const TApaAppIdentifier &)Writes the application identifier to a new stream in the specified store and rec...
• WriteRootStreamL(CPersistentStore &,CStreamDictionary &,const CApaApplication &)Writes the application identifier (derived from the application object CApaAppli...
• WriteRootStreamL(CPersistentStore &,CStreamDictionary &,const TApaAppIdentifier &)Writes the application identifier followed by the stream dictionary to the store...

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

IMPORT_C ~CEikProcess();

Description

Destructor.

Destroys the main document.

IMPORT_C TPtrC CommandTailEnd() const;

Description

Returns the command tail end - i.e. command line parameters

Return value

TPtrC16 CommandTailEnd.

IMPORT_C TFileName MainDocFolder() const;

Description

Returns the drive and path of the main document.

Return value

TBuf The drive and path of the main document. This excludes the filename.

IMPORT_C void SetLastUsedFileL(TLastUsedFile aType, const TDesC &aFileName) const;

Description

Sets the name of either the last opened or the last created file.

The information is written to the .ini file of the application associated with the main document. It attempts to create an .ini file if one does not exist.

Parameters

CEikProcess::TLastUsedFile aType Indicates whether aFileName is the name of the last opened or last created file. const TDesC16 &aFileName The name of the last opened or last created file.

IMPORT_C TFileName LastUsedFileL(TLastUsedFile aType) const;

Description

Gets the name of either the last opened or last created file.

The information is read from the .ini file of the application associated with the main document. The function cannot leave. If an error occurs, the function returns an empty filename.

Parameters

CEikProcess::TLastUsedFile aType Indicates whether the function should return the name of the last opened or last created file.

Return value

TBuf The name of the last opened or last created file.

IMPORT_C void SetMainStore(CFileStore *aMainStore);

Description

Sets the file store that stores the main document.

A main store must have been set before you can call CEikProcess::SaveToDirectFileStoreL(CEikDocument *,const TFileName *).

Parameters

CFileStore *aMainStore The file store object which is used to store the main document.

IMPORT_C CFileStore* MainStore() const;

Description

Gets a pointer to the main store. This is the file store that holds the main document.

Return value

CFileStore * The main store, or NULL if it has not been set.

IMPORT_C void AppFromDocL(TDes &aLibraryName, const TDesC &aDocumentName) const;

Description

Gets the name of the application DLL associated with the specified document.

Parameters

TDes16 &aLibraryName On return, holds the path and filename of the application DLL. const TDesC16 &aDocumentName The path and filename of the document file.

Leave codes

KErrCorrupt The document file is not valid (its UID2 must be KUidAppDllDoc).

IMPORT_C void SaveToDirectFileStoreL(CEikDocument *aDoc, const TFileName *aNewFileName=0);

Description

Saves the main document optionally to a new file.

If aNewFileName is specified, a new file with that name is created, and the main document is saved to it. This file is opened for writing.

If aNewFileName is NULL, the main document is saved and is opened for writing.

Parameters

CEikDocument *aDoc The main document. const TBuf *aNewFileName The optional new filename for the main document. This file should not already exist.

Panic codes

EIKON 44 The main store has not been allocated. EIKON 45 The main store is not a direct file store (its first UID is not KDirectFileStoreLayoutUid).

IMPORT_C void SaveToDirectFileStoreL(CEikDocument *aDoc, const TFileName *aNewFileName, TBool aReopen, TFileName *aTempFile=0);

Description

Saves the main document optionally to a new file, and optionally opens it.

Parameters

CEikDocument *aDoc The main document. const TBuf *aNewFileName The optional new filename for the main document. This file should not already exist. If specified, a new file with this name is created, and the main document is saved to it; aTempFile is not used. If NULL, the main document is saved to a temporary file, whose name is returned in aTempFile. TBool aReopen If true, the main document file is set to the contents of any temporary file created, if applicable, and the newly created main document file is opened for writing. If false, the temporary file (if created) or the main document file remains closed. TBuf *aTempFile If not NULL, on return, this holds the path and filename of the temporary file created and into which the document was saved.

Panic codes

EIKON 44 The main store has not been allocated. EIKON 45 The main store is not a direct file store (its first UID is not KDirectFileStoreLayoutUid).

TLastUsedFile

Description

Used as a parameter by CEikProcess::SetLastUsedFileL(TLastUsedFile,const TDesC &)const and CEikProcess::LastUsedFileL(TLastUsedFile)const to indicate whether the function relates to the last opened or last created file.

ELastOpenFile Last opened file. ELastCreatedFile Last created file.