wpclsRemoveObjects
This class method removes all specified objects from a given container and the in-use list. This method is specific to version 3, or higher, of the OS/2 operating system.
Syntax
wpclsRemoveObjects(somSelf, hwndCnr, pRecordArray, NumRecords, RemoveAll);
Parameters
- somSelf (M_WPObject *) - input
- Pointer to the WPObject class object.
- hwndCnr (HWND) - input
- Handle to the container object.
- pRecordArray (PVOID *) - input
- Pointer to an array of MINIRECORDCORE objects that are to be removed.
- NumRecords (ULONG) - input
- Number of records in pRecordArray.
- RemoveAll (BOOL) - input
- Flag indicating whether to remove all records.
- TRUE – All records in the specified container are to be removed, and the in-use list for each object is cleaned up.
- FALSE – Only records specified in pRecordArray are to be removed, and the in-use list is cleaned up for those objects.
Returns
- rc (BOOL) - returns
- Success indicator.
- TRUE – Successful completion.
- FALSE – Error occurred.
Remarks
This method provides rapid removal of multiple objects from a container at one time. wpCnrRemoveObject performs a similar function but only operates on a single object at a time.
Usage
This method can be called at any time to remove multiple objects from the container.
How to Override
This method is generally not overridden.