wpDeleteContents

This instance method is called to delete the contents of a folder.

Syntax

_wpDeleteContents(somSelf, fConfirmations)

Parameters

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

fConfirmations (ULONG) - input

Confirmation flags.

CONFIRM_DELETE Prompt for confirmation for all objects.
CONFIRM_DELETEFOLDER Prompt for confirmation for folder objects only.
NULL No confirmations.

Returns

rc (ULONG) - returns

Success indicator.

OK_DELETE All objects were deleted.
NO_DELETE Error occurred. At least one object was not deleted.
CANCEL_DELETE User canceled the operation.

How to Override

This method is generally not overridden.

Usage

This method can be called at any time in order to delete the contents of a folder.

Example Code

#define INCL_WINWORKPLACE
#include <os2.h>

WPFolder *somSelf; /* Pointer to the object on which the method is being invoked. */
ULONG fConfirmations; /* Confirmation flags. */
ULONG rc; /* Success indicator. */

rc = _wpDeleteContents(somSelf, fConfirmations);

Remarks

wpDelete and wpFree will automatically call this instance method for folder objects.

Related Methods