Jump to content

wpRestoreFldrRunObjs

From EDM2

This method is specific to Version 4, or higher, of the OS/2 operating system.

This instance method is called when a work area folder is opened. It goes through the list of objects last saved by wpStoreFldrRunObjs and reopens all views of those objects that were open when the work area folder was last closed.

Syntax

_wpRestoreFldrRunObjs(somSelf)

Parameters

somSelf (WPFolder *) - input
Pointer to the object on which the method is being invoked.
Points to an object of class WPFolder.

Returns

rc (BOOL) - returns
Success indicator
  • TRUE Successful completion.
  • FALSE Error occurred.

How to Override

This method is not generally overridden.

Usage

This method can be called at any time to restore all objects that were open when a work area folder was last closed.

Example Code

#define INCL_WINWORKPLACE
#include <os2.h>

WPFolder *somSelf; /* Pointer to the object on which the method is being invoked. */
BOOL rc; /* Success indicator */

rc = _wpRestoreFldrRunObjs(somSelf);

Remarks

The system calls this method when it is opening a work area folder. This method is only called on folders with the **FOI_WORKAREA** flag set when the folder is opened.

Example Code

This example restores all of the objects that were open when the specified folder was last closed.

 _wpRestoreFldrRunObjs(WorkAreaFolder);

Related Methods