Constructor for CApaProcess

Constructs the application process object with the specified file session handle.

Derived classes must define and implement a constructor through which the file session handle can be specified. A typical implementation calls this constructor through a constructor initialization list.

This constructor is used by the UI framework.

Frees resources prior to destruction.

Documents must be saved before the application process is deleted, otherwise data may be lost.

In debug mode, the destructor raises an APPARC 6 panic if documents still exist, and an APPARC 5 panic if applications still exist.

Creates and adds a new document using the specified application factory.

The document may be a main document or an embedded document.

Any document created with this function must be destroyed using DestroyDocument() .

CApaProcess::DestroyDocument() CApaApplication

Reserved for future use

Reserved for future use

Completes construction of the application process object.

Implementers of derived classes must call this function as part of the second stage construction of an object. Typically, derived classes implement their own NewL() function and call ConstructL() as part of that implementation.

Completes construction of the application process object, passing in a Parent Process Identifier.

Implementers of derived classes must call this function as part of the second stage construction of an object. Typically, derived classes implement their own NewL() function and call ConstructL() as part of that implementation.

Destroys the specified document.

All references to the document are removed, and associated resources are freed. Specifically, the function deletes any associated application and unloads the application DLL, provided that no other documents of that application type are still open.

All document objects created through CApaProcess must be deleted using this function.

CApaApplication CApaProcess

Returns a handle to the file server session used by this application process.

Returns the filename of the main document.

Returns a pointer to the main document.

Creates and returns a pointer to a new application process.

This function is not used by UI applications.

Opens the specified file and restores the content as a document.

The created document can be merged into or embedded in another document.

Any document created with this function must be destroyed using DestroyDocument() .

TFileMode CApaProcess::DestroyDocument()

Reads the application identifier from its stream in the specified store and returns it.

The location of the stream is found in the specified stream dictionary.

Reads the stream dictionary contained as the root stream in the specified document file.

The function constructs, and returns a pointer to the stream dictionary object and puts the pointer to the stream dictionary object onto the cleanup stack. It also returns a pointer to the created file store object through an argument reference.

The file must be a valid document file; otherwise the function leaves with one of the system-wide error codes.

TFileMode

Resets the the application process to its initial state.

Specifically, it saves the main document, deletes the main and all embedded documents from memory, resets the main document filename and deletes all applications except the main application.

The function can leave if saving the main document fails.

Sets the filename of the main document.

Sets the filename of the main document.

Sets the main document.

CApaProcess::AddNewDocumentL() CApaProcess::OpenNewDocumentL()

Writes the application identifier to a new stream in the specified store and records the location of this stream in the specified stream dictionary.

Writes the application identifier (derived from the application object CApaApplication ) followed by the stream dictionary to the store and makes the stream dictionary the root stream of the store.

Typically, the function is called by the application when it implements a file create or file save type operation. It is called after all model and UI data has been persisted. The IDs of the streams containing the model and UI data should have been lodged in the stream dictionary.

In effect, the function finishes off the file save or file create type operation, leaving the file containing the store in a valid state with the standard interface.

Writes the application identifier followed by the stream dictionary to the store and makes the stream dictionary the root stream of the store.

Typically, the function is called by the application when it implements a file create or file save type operation. It is called after all model and UI data has been persisted. The IDs of the streams containing the model and UI data should have been lodged in the stream dictionary.

In effect, the function finishes off the file save or file create type operation, leaving the file containing the store in a valid state with the standard interface.