Jump to content

wpclsInsertMultipleObjects

From EDM2
Revision as of 22:48, 24 May 2025 by Martini (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This class method inserts multiple objects into a container at one time. It is specific to version 3 or higher of the OS/2 operating system.

Syntax

rc = _wpclsInsertMultipleObjects(somSelf, hwndCnr, pptlIcon, pObjectArray, pRecordParent, NumRecords);

Parameters

somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
hwndCnr (HWND) - input
Handle to the container window in which objects are to be inserted.
pptlIcon (PPOINTL) - input
Pointer to the initial icon position of the first icon inserted.
pObjectArray (PVOID *) - input
Pointer to an array of object pointers. The objects in this array are to be inserted into the container.
pRecordParent (PVOID) - input
Pointer to the parent record. This parameter should be set to NULL if the records being inserted will not have a parent or tree view is not supported.
NumRecords (ULONG) - input
Number of records in `pObjectArray` to be inserted. This parameter must be greater than 0.

Returns

rc (BOOL) - returns
Success indicator.
Value Description
TRUE Successful completion.
FALSE Errors occurred.

Remarks

This method provides rapid insertion of multiple objects into a container at once. wpCnrInsertObject performs the same function as this method, but operates only on one object at a time. This method adds each object to the in-use list.

Usage

This method can be called at any time to add multiple objects to a container.

How to Override

This method is generally not overridden.

Related Methods