Jump to content

wpStoreFldrRunObjs

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 closed. It saves a list of the objects within the work area folder that are open when the work area folder is closed. It then closes all open views of these objects.

Syntax

_wpStoreFldrRunObjs(somSelf, ulType)

Parameters

somSelf (WPFolder *) - input
Pointer to the object on which the method is being invoked.
Points to an object of class WPFolder.
ulType (ULONG) - input
Folder type flag.
  • **FOI_WORKAREA** Designates a work area folder.

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 save the list of open objects in a folder.

Remarks

The system calls this method while closing a work area folder to save the list of objects that are open so they can be restored when the folder is reopened. This method is only called on folders with the **FOI_WORKAREA** flag set when the folder is closed.

Example Code

#define INCL_WINWORKPLACE
#include <os2.h>

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

rc = _wpStoreFldrRunObjs(somSelf, ulType);

This example saves the state of all open objects in a work area folder and closes all open views of the folder.

 _wpStoreFldrRunObjs(WorkAreaFolder,CLOSE_FOLDER);

Related Methods