Jump to content

wpConfirmDelete

From EDM2

This instance method is called to allow the object to prompt the user to confirm the deletion of this object.

Syntax

_wpConfirmDelete(somSelf, fConfirmations)

Parameters

somSelf (WPObject *) - input
Pointer to the object on which the method is being invoked.
Points to an object of class WPObject.
fConfirmations (ULONG) - input
Confirmation flags.
CONFIRM_DELETE Confirm for delete of all objects.
CONFIRM_DELETEFOLDER Confirm for delete of folder objects only.

Returns

rc (ULONG) - returns
User-response value. The default processing returns one of the following:
OK_DELETE Deletion of this object is confirmed.
NO_DELETE Deletion of this object is cancelled.
CANCEL_DELETE Deletion process from that point on is cancelled.

Remarks

This method is called during the processing of the wpDelete method only if the system confirm on delete flag is set.

Usage

This method is generally called only by the system.

How to Override

This method should be overridden in order to remove or replace the user prompt to confirm the delete operation.

Example Code

#define INCL_WINWORKPLACE
#include <os2.h>

WPObject      *somSelf;        /* Pointer to the object on which the method is being invoked. */
ULONG          fConfirmations; /* Confirmation flags. */
ULONG          rc;             /* User-response value. */

rc = _wpConfirmDelete(somSelf, fConfirmations);

Related Methods