Jump to content

wpHideFldrRunObjs

From EDM2
Revision as of 02:37, 17 November 2025 by Martini (talk | contribs) (Created page with "{{DISPLAYTITLE:wpHideFldrRunObjs}} For work area folders, this instance method is called to allow the folder to hide or minimize its open objects. ==Syntax== _wpHideFldrRunObjs(somSelf, fHide) ==Parameters== ;''somSelf'' (WPFolder *) - input :Pointer to the object on which the method is being invoked. :Points to an object of class WPFolder. ;''fHide'' (BOOL) - input :Flag indicating whether to hide or show open objects. :* **TRUE** Hide all objects opened...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

For work area folders, this instance method is called to allow the folder to hide or minimize its open objects.

Syntax

_wpHideFldrRunObjs(somSelf, fHide)

Parameters

somSelf (WPFolder *) - input
Pointer to the object on which the method is being invoked.
Points to an object of class WPFolder.
fHide (BOOL) - input
Flag indicating whether to hide or show open objects.
  • **TRUE** Hide all objects opened from this folder.
  • **FALSE** Show all objects opened from this folder.

Returns

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

How to Override

This method is generally not overridden.

Usage

This method can be called at any time in order to hide or minimize all currently open objects in this folder.

Remarks

Open objects in this folder will either be hidden or minimized, depending on the current system setting. This method is called automatically on folders with the work area flag, **FOI_WORKAREA**, set when the folder itself is hidden or minimized.

Example Code

#define INCL_WINWORKPLACE
#include <os2.h>

WPFolder *somSelf; /* Pointer to the object on which the method is being invoked. */
BOOL fHide; /* Flag indicating whether to hide or show open objects. */
BOOL rc; /* Success indicator. */

rc = _wpHideFldrRunObjs(somSelf, fHide);