wpModifyFldrFlags

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

This instance method either sets or removes folder status flags from a given folder.

Syntax

_wpModifyFldrFlags(somSelf, ulFlags, ulFlagMask)

Parameters

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

ulFlags (ULONG) - input

Status flags to be set or cleared.

Possible values are described in the following list. Values can be combined to modify multiple flags in a single call.

**FOI_POPULATEWITHALL**
**FOI_POPULATEWITHFOLDERS**
**FOI_WORKAREA**
**FOI_CHANGEFONT**
**FOI_WAMINIMIZE**
**FOI_WASTARTONRESTORE**
**FOI_NOREFRESHVIEWS**
**FOI_ASYNCREFRESHONOPEN**
**FOI_TREEPOPULATE**
**FOI_POPULATEINPROGRESS**
**FOI_REFRESHINPROGRESS**
**FOI_FIRSTPOPULATE**
**FOI_WAMCRINPROGRESS**
**FOI_CNRBKGNDOLDFORMAT**
**FOI_CHANGEICONBGNDCOLOR**
**FOI_CHANGEICONTEXTCOLOR**
**FOI_DELETEINPROGRESS**
**FOI_CHANGESHADOWTEXTCOLOR**

ulFlagMask (ULONG) - input: Folder flags in **ulFlags** to be set or cleared.; Values specified correspond to the flag values specified in **ulFlags**. If the value in **ulFlagMask** is specified (the bit is 1), the corresponding folder flag is set. If the value in **ulFlagMask** is not specified (the bit is 0), the corresponding folder flag is cleared.

Returns

rc (BOOL) - returns

Success indicator.

TRUE Successful completion.
FALSE Error occurred.

How to Override

This method is generally not overridden.

Usage

This instance method can be called at any time to change a folder's status.

Remarks

This method sets or clears the corresponding folder flags as an **atomic operation**. This method can be used instead of wpQueryFldrFlags and wpSetFldrFlags.

Example Code

#define INCL_WINWORKPLACE
#include <os2.h>

WPFolder *somSelf; /* Pointer to the object on which the method is being invoked. */
ULONG ulFlags; /* Status flags to be set or cleared. */
ULONG ulFlagMask; /* Folder flags in ulFlags to be set or cleared. */
BOOL rc; /* Success indicator. */

rc = _wpModifyFldrFlags(somSelf, ulFlags,
        ulFlagMask);

The following code marks the folder as a workarea.

_wpModifyFldrFlags (self, FOI_WORKAREA ,
                              FOI_WORKAREA);

Related Methods